Phone (408) 775-7720
Email : support@onlinecheckwriter.com
Live Chat : Click Here
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Need any Instant Support :","slug":"need-any-instant-support"}],"owner":"3737507","collectionId":"d83f9dc8-d45c-40b2-84e3-6c5f0b4079d9","publishedId":"UV5WDJ1Y","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-03-04T22:04:22.000Z"},"item":[{"name":"Getting Started","item":[{"name":"Sandbox","item":[],"id":"9a00f876-587f-4d62-a551-787a119803a8","description":"Sign up for a test account and get your API key.
\nIf verification issues arise, contact customer support via live chat or email.
\nDownload Postman and set the base URL https://test.onlinecheckwriter.com/api/v3
Configure your Authorization Key in Postman.
\nAdd a test bank account using provided sample numbers.
\nRun a comprehensive test to confirm setup.
\nFor optional ACH/Direct Deposit testing, contact support.
\nReach out to support for any setup issues support@onlinecheckwriter.com
\nhttps://app.onlinecheckwriter.com/api/v3Do you know we do have an
\n","_postman_id":"ffb6d277-340e-4c56-a838-abad46f639f8"}],"id":"6fedbc4a-638b-48e7-bd0b-c44679b222ea","_postman_id":"6fedbc4a-638b-48e7-bd0b-c44679b222ea","description":""},{"name":"Quick Pay","item":[{"name":"Create Check","event":[{"listen":"test","script":{"id":"bb140907-168f-4ab9-9a7c-16002c80d9cb","exec":["const resp = pm.response.json();\r","\r","\r","if(pm.response.code==200 && resp.success == true){\r","\r"," pm.environment.set(\"checkId\", resp.data.checkId);\r","\r","}\r","if(pm.response.code==201 && resp.success == true){\r","\r"," pm.environment.set(\"checkId\", resp.data.checkId);\r","\r","}\r",""],"type":"text/javascript","packages":{}}}],"id":"7959e448-557f-4c83-a23e-e3999c506cee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{AUTH_TOKEN}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"source\": {\r\n \"accountType\": \"bankaccount\",\r\n \"accountId\": \"{{bankAccountId}}\"\r\n },\r\n \"destination\": {\r\n \"name\": \"John Myres\",\r\n \"company\": \"Tyler Payment Technologist\",\r\n \"address1\": \"5007 richmond rd\",\r\n \"address2\": \"\",\r\n \"city\": \"Tyler\",\r\n \"state\": \"TX\",\r\n \"zip\": \"75701\",\r\n \"phone\": \"9032457713\",\r\n \"email\": \"support@onlinecheckwriter.com\"\r\n },\r\n \"payment_details\": {\r\n \"amount\": 500,\r\n \"memo\": \"for game\",\r\n \"note\": \"Note For Internal Purpose\",\r\n \"referenceID\": \"12\",\r\n \"issueDate\": \"2024-07-01\",\r\n \"customElements\": {\r\n \"element1\": \"first class tracking\",\r\n \"element2\": \"test sender\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/quickpay/check","description":"","urlObject":{"path":["quickpay","check"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"ca7aefc8-b1d3-48ac-87b9-449216d68140","name":"Create Check","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"source\": {\r\n \"accountType\": \"bankaccount\",\r\n \"accountId\": \"{{bankAccountId}}\"\r\n },\r\n \"destination\": {\r\n \"name\": \"John Myres\",\r\n \"company\": \"Tyler Payment Technologist\",\r\n \"address1\": \"5007 richmond rd\",\r\n \"address2\": \"\",\r\n \"city\": \"Tyler\",\r\n \"state\": \"TX\",\r\n \"zip\": \"75701\",\r\n \"phone\": \"9032457713\",\r\n \"email\": \"support@onlinecheckwriter.com\"\r\n },\r\n \"payment_details\": {\r\n \"amount\": 500,\r\n \"memo\": \"for game\",\r\n \"note\": \"Note For Internal Purpose\",\r\n \"referenceID\": \"12\",\r\n \"issueDate\": \"2024-07-01\",\r\n \"customElements\": {\r\n \"element1\": \"first class tracking\",\r\n \"element2\": \"test sender\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/quickpay/check"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Sat, 02 Sep 2023 12:36:30 GMT"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"Referrer-Policy","value":"unsafe-url"},{"key":"Permissions-Policy","value":"fullscreen=(), geolocation=()"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"checkId\": \"6gYVewMJO54dx7b\"\n }\n}"}],"_postman_id":"7959e448-557f-4c83-a23e-e3999c506cee"},{"name":"Create Echeck","id":"645c6fe8-69ae-49c3-ba81-dc375d46dacb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{AUTH_TOKEN}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"source\" :\r\n {\r\n \"accountType\" : \"bankaccount\",\r\n \"accountId\" : \"{{bankAccountId}}\"\r\n },\r\n \"destination\":\r\n {\r\n \"name\": \"John Myres\",\r\n \"company\": \"Tyler Payment Technologist\",\r\n \"address1\" :\"12456 richmond rd\",\r\n \"address2\":\"Apartment 2022\",\r\n \"city\":\"Tyler\",\r\n \"state\":\"TX\",\r\n \"zip\":\"75701\",\r\n \"phone\":\"9032457713\",\r\n \"email\":\"support@onlinecheckwriter.com\"\r\n },\r\n\r\n \"payment_details\":\r\n {\r\n \"amount\":984,\r\n \"memo\":\"for game\",\r\n \"note\": \"Note For Internal Purpose\",\r\n \"issueDate\" : \"2024-07-01\"\r\n }\r\n\r\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/quickpay/echeck","description":"","urlObject":{"path":["quickpay","echeck"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"f0506624-8468-45ab-aa55-5dc9184f7e75","name":"Create Echeck","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"source\" :\r\n {\r\n \"accountType\" : \"bankaccount\",\r\n \"accountId\" : \"{{bankAccountId}}\"\r\n },\r\n \"destination\":\r\n {\r\n \"name\": \"John Myres\",\r\n \"company\": \"Tyler Payment Technologist\",\r\n \"address1\" :\"12456 richmond rd\",\r\n \"address2\":\"Apartment 2022\",\r\n \"city\":\"Tyler\",\r\n \"state\":\"TX\",\r\n \"zip\":\"75701\",\r\n \"phone\":\"9032457713\",\r\n \"email\":\"support@onlinecheckwriter.com\"\r\n },\r\n\r\n \"payment_details\":\r\n {\r\n \"amount\":984,\r\n \"memo\":\"for game\",\r\n \"note\": \"Note For Internal Purpose\",\r\n \"issueDate\" : \"2024-07-01\"\r\n }\r\n\r\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/quickpay/echeck"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Sat, 02 Sep 2023 12:36:45 GMT"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"Referrer-Policy","value":"unsafe-url"},{"key":"Permissions-Policy","value":"fullscreen=(), geolocation=()"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Successfully Sent\",\n \"data\": {\n \"checkId\": \"VPXre6L8pZ4zl9Z\"\n }\n}"}],"_postman_id":"645c6fe8-69ae-49c3-ba81-dc375d46dacb"},{"name":"Create MailCheck","id":"ab01c63f-3797-4f19-815a-ad9ad453ce4f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{AUTH_TOKEN}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"source\" :\r\n {\r\n \"accountType\" : \"bankaccount\",\r\n \"accountId\" : \"{{bankAccountId}}\"\r\n },\r\n \"destination\":\r\n {\r\n \"name\": \"John Myres\",\r\n \"company\": \"Tyler Payment Technologist\",\r\n \"address1\" :\"5007 richmond rd\",\r\n \"address2\":\"\",\r\n \"city\":\"Tyler\",\r\n \"state\":\"TX\",\r\n \"zip\":\"75701\",\r\n \"phone\":\"9032457713\",\r\n \"email\":\"support@onlinecheckwriter.com\",\r\n \"shippingTypeId\":1\r\n },\r\n\r\n \"payment_details\":\r\n {\r\n \"amount\":984,\r\n \"memo\":\"for game\",\r\n \"note\": \"Note For Internal Purpose\",\r\n \"issueDate\" : \"2024-07-01\"\r\n }\r\n\r\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/quickpay/mailcheck","description":"shippingTypeId
\n","urlObject":{"path":["quickpay","mailcheck"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"1010a92b-66aa-4595-97b6-9ba36a98be85","name":"Create MailCheck","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"source\": {\r\n \"accountType\": \"bankaccount\",\r\n \"accountId\": \"{{bankAccountId}}\"\r\n },\r\n \"destination\": {\r\n \"name\": \"John Myres\",\r\n \"company\": \"Tyler Payment Technologist\",\r\n \"address1\": \"12456 richmond rd\",\r\n \"address2\": \"Apartment 2022\",\r\n \"city\": \"Tyler\",\r\n \"state\": \"TX\",\r\n \"zip\": \"75701\",\r\n \"phone\": \"9032457713\",\r\n \"email\": \"support@onlinecheckwriter.com\",\r\n \"shippingTypeId\": 1\r\n },\r\n \"payment_details\": {\r\n \"amount\": 984,\r\n \"memo\": \"for game\",\r\n \"note\": \"Note For Internal Purpose\",\r\n \"issueDate\": \"2024-07-01\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/quickpay/mailcheck"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Sat, 02 Sep 2023 12:36:45 GMT"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"Referrer-Policy","value":"unsafe-url"},{"key":"Permissions-Policy","value":"fullscreen=(), geolocation=()"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Successfully Sent\",\n \"data\": {\n \"checkId\": \"VPXre6L8pZ4zl9Z\"\n }\n}"}],"_postman_id":"ab01c63f-3797-4f19-815a-ad9ad453ce4f"},{"name":"Create Bundle Mail","id":"863caec1-f056-45ce-8866-6c9844ba5bf3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{AUTH_TOKEN}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"checkIds\": [\r\n \"VPXre6NoVbezl9Z\",\r\n \"BQPA4mv7RAG7gxq\"\r\n ],\r\n \"fromAddress\": {\r\n \"name\": \"From address\",\r\n \"companyName\": \"\",\r\n \"addressLine1\": \"2915 Frederick Street\",\r\n \"addressLine2\": \"9466 Del Monte Ave.Lindenhurst, NY 11757\",\r\n \"city\": \"SAINT PETERS\",\r\n \"state\": \"MO\",\r\n \"zip\": \"63376\",\r\n \"phone\": \"900244400\",\r\n \"email\": \"email@test.com\",\r\n \"note\": \"\"\r\n },\r\n \"toAddress\": {\r\n \"name\": \"To address\",\r\n \"companyName\": \"\",\r\n \"addressLine1\": \"2915 Frederick Street\",\r\n \"addressLine2\": \"9466 Del Monte Ave.Lindenhurst, NY 11757\",\r\n \"city\": \"SAINT PETERS\",\r\n \"state\": \"MO\",\r\n \"zip\": \"63376\",\r\n \"phone\": \"900244400\",\r\n \"email\": \"email@test.com\",\r\n \"note\": \"\"\r\n },\r\n \"shippingTypeId\" : 4\r\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/quickpay/bundle-mail","description":"If you want to test this feature talk with our customer support team.
\n","urlObject":{"path":["quickpay","directdeposit"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"5ed6e5ef-3249-4710-a743-286dad05d008","name":"Create Direct Deposit","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"source\" :\r\n {\r\n \"accountType\" : \"wallet\",\r\n \"accountId\" : \"d99d642f-223a-485e-97b2-ff98a62c636d\"\r\n },\r\n \"destination\":\r\n {\r\n \"name\": \"John Myres\",\r\n \"company\": \"Tyler Payment Technologist\",\r\n \"address1\" :\"12456 richmond rd\",\r\n \"address2\":\"Apartment 2022\",\r\n \"city\":\"Tyler\",\r\n \"state\":\"TX\",\r\n \"zip\":\"75701\",\r\n \"phone\":\"9032457713\",\r\n \"email\":\"support@onlinecheckwriter.com\",\r\n \"routing_number\":\"021000021\",\r\n \"account_number\":\"123456789\"\r\n },\r\n\r\n \"payment_details\":\r\n {\r\n \"amount\":984,\r\n \"memo\":\"for game\",\r\n \"note\": \"Note For Internal Purpose\"\r\n }\r\n\r\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/quickpay/directdeposit"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"127.0.0.1:8000"},{"key":"Date","value":"Wed, 06 Sep 2023 10:38:18 GMT"},{"key":"Date","value":"Wed, 06 Sep 2023 10:38:18 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.4.30"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": \"4686a587-550b-485a-9b6b-6efdacff46ce\"\n }\n}"}],"_postman_id":"a692614f-8c72-47a2-8d96-f9199704b7e1"},{"name":"Create Virtual Card","id":"f0443154-6a5c-45b9-81ba-8a0945636b60","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{AUTH_TOKEN}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"source\" :\r\n {\r\n \"accountType\" : \"wallet\",\r\n \"accountId\" : \"{{walletId}}\"\r\n },\r\n \"destination\":\r\n {\r\n \"name\": \"John Myres\",\r\n \"company\": \"Tyler Payment Technologist\",\r\n \"address1\" :\"12456 richmond rd\",\r\n \"address2\":\"Apartment 2022\",\r\n \"city\":\"Tyler\",\r\n \"state\":\"TX\",\r\n \"zip\":\"75701\",\r\n \"phone\":\"9032457713\",\r\n \"email\":\"support@onlinecheckwriter.com\"\r\n \r\n },\r\n\r\n \"payment_details\":\r\n {\r\n \"amount\":984,\r\n \"memo\":\"for game\",\r\n \"note\": \"Note For Internal Purpose\"\r\n }\r\n\r\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/quickpay/virtualcard","description":"This program is still in beta. Please speak with our customer support team to enable this feature.
\n","urlObject":{"path":["quickpay","virtualcard"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"3004f773-b73d-4641-87a8-d8d56dc067de","name":"Create Virtual Card","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"source\" :\r\n {\r\n \"accountType\" : \"wallet\",\r\n \"accountId\" : \"{{walletId}}\"\r\n },\r\n \"destination\":\r\n {\r\n \"name\": \"John Myres\",\r\n \"company\": \"Tyler Payment Technologist\",\r\n \"address1\" :\"12456 richmond rd\",\r\n \"address2\":\"Apartment 2022\",\r\n \"city\":\"Tyler\",\r\n \"state\":\"TX\",\r\n \"zip\":\"75701\",\r\n \"phone\":\"9032457713\",\r\n \"email\":\"support@onlinecheckwriter.com\"\r\n \r\n },\r\n\r\n \"payment_details\":\r\n {\r\n \"amount\":984,\r\n \"memo\":\"for game\",\r\n \"note\": \"Note For Internal Purpose\"\r\n }\r\n\r\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/quickpay/virtualcard"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 05 Sep 2023 13:07:45 GMT"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"Referrer-Policy","value":"unsafe-url"},{"key":"Permissions-Policy","value":"fullscreen=(), geolocation=()"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"checkId\": \"72d39a23-02f0-4e76-80e2-d21abc1ae5ae\"\n }\n}"}],"_postman_id":"f0443154-6a5c-45b9-81ba-8a0945636b60"},{"name":"Create Wire Transfer","id":"e6681589-ba84-466c-acdc-3781c576d35d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{AUTH_TOKEN}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"source\" :\r\n {\r\n \"accountType\" : \"wallet\",\r\n \"accountId\" : \"{{walletId}}\"\r\n },\r\n \"destination\":\r\n {\r\n \"name\": \"John Myres\",\r\n \"company\": \"Tyler Payment Technologist\",\r\n \"address1\" :\"12456 richmond rd\",\r\n \"address2\":\"Apartment 2022\",\r\n \"city\":\"Tyler\",\r\n \"state\":\"TX\",\r\n \"zip\":\"75701\",\r\n \"phone\":\"9032457713\",\r\n \"email\":\"support@onlinecheckwriter.com\",\r\n \"routing_number\":\"021000021\",\r\n \"account_number\":\"123456789\"\r\n },\r\n\r\n \"payment_details\":\r\n {\r\n \"amount\":984,\r\n \"memo\":\"for game\",\r\n \"note\": \"Note For Internal Purpose\"\r\n }\r\n\r\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/quickpay/wire","urlObject":{"path":["quickpay","wire"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"163760a2-2940-461d-aa8b-d4a1018d9fd8","name":"Create Wire Transfer","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"source\" :\r\n {\r\n \"accountType\" : \"wallet\",\r\n \"accountId\" : \"{{walletId}}\"\r\n },\r\n \"destination\":\r\n {\r\n \"name\": \"John Myres\",\r\n \"company\": \"Tyler Payment Technologist\",\r\n \"address1\" :\"12456 richmond rd\",\r\n \"address2\":\"Apartment 2022\",\r\n \"city\":\"Tyler\",\r\n \"state\":\"TX\",\r\n \"zip\":\"75701\",\r\n \"phone\":\"9032457713\",\r\n \"email\":\"support@onlinecheckwriter.com\",\r\n \"routing_number\":\"021000021\",\r\n \"account_number\":\"123456789\"\r\n },\r\n\r\n \"payment_details\":\r\n {\r\n \"amount\":984,\r\n \"memo\":\"for game\",\r\n \"note\": \"Note For Internal Purpose\"\r\n }\r\n\r\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/quickpay/wire"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"127.0.0.1:8000"},{"key":"Date","value":"Wed, 06 Sep 2023 11:20:54 GMT"},{"key":"Date","value":"Wed, 06 Sep 2023 11:20:54 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.4.30"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": \"29260b04-b6dc-45be-abfa-6a688c677f1c\"\n }\n}"},{"id":"f9d4eac1-0ba9-46c3-af13-99cc4b642880","name":"Create Wire Transfer","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"source\" :\r\n {\r\n \"accountType\" : \"wallet\",\r\n \"accountId\" : \"{{walletId}}\"\r\n },\r\n \"destination\":\r\n {\r\n \"name\": \"John Myres\",\r\n \"company\": \"Tyler Payment Technologist\",\r\n \"address1\" :\"12456 richmond rd\",\r\n \"address2\":\"Apartment 2022\",\r\n \"city\":\"Tyler\",\r\n \"state\":\"TX\",\r\n \"zip\":\"75701\",\r\n \"phone\":\"9032457713\",\r\n \"email\":\"support@onlinecheckwriter.com\",\r\n \"routing_number\":\"021000021\",\r\n \"account_number\":\"123456789\"\r\n },\r\n\r\n \"payment_details\":\r\n {\r\n \"amount\":984,\r\n \"memo\":\"for game\",\r\n \"note\": \"Note For Internal Purpose\"\r\n }\r\n\r\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/quickpay/wire"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"127.0.0.1:8000"},{"key":"Date","value":"Wed, 06 Sep 2023 11:20:54 GMT"},{"key":"Date","value":"Wed, 06 Sep 2023 11:20:54 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.4.30"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": \"29260b04-b6dc-45be-abfa-6a688c677f1c\"\n }\n}"}],"_postman_id":"e6681589-ba84-466c-acdc-3781c576d35d"},{"name":"Sent Pdf","id":"2ce9b038-668d-44f4-9715-c15a44cdd19b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{AUTH_TOKEN}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\": \"New Payee\",\r\n \"company\": \"Tyler Payment Technologist\",\r\n \"address1\": \"5007 richmond rd\",\r\n \"address2\": \"\",\r\n \"city\": \"Tyler\",\r\n \"state\": \"TX\",\r\n \"zip\": \"75701\",\r\n \"phone\": \"111111111\",\r\n \"email\": \"support@onlinecheckwriter.com\",\r\n \"shippingTypeId\": 3,\r\n \"attachmentUrl\": \"https://www.onlinecheckwriter.com/samples/invoice/invoicesample.pdf\",\r\n \"attachmentTitle\": \"Invoice 1244\",\r\n \"fromAddress\": {\r\n \"name\": \"David Abraham\",\r\n \"company\": \"David LLC\",\r\n \"address1\": \"450 Sutter Street\",\r\n \"address2\": \"\",\r\n \"city\": \"San Francisco\",\r\n \"state\": \"CA\",\r\n \"zip\": \"94108\",\r\n \"phone\": \"987564128\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/quickpay/mailpdf","description":"This is not a payment method. Sometimes you may want to send a QuickPDF to your employee, and this feature allows you to do that.
\nWe also support an HTML to PDF document mailing feature. If you need a more advanced way of sending documents, consider using our Mail Document API: Mail Document API.
\nFor more examples, visit: How to Send PDF to Your Recipient Easily.
\nShipping Type ID: 1, for regular USPS First Class mailing
\n","urlObject":{"path":["quickpay","mailpdf"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"e50409c2-a3a9-4fcc-a5a7-369b4f984c24","name":"Sent Pdf","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\": \"New Payee\",\r\n \"company\": \"Tyler Payment Technologist\",\r\n \"address1\": \"5007 richmond rd\",\r\n \"address2\": \"\",\r\n \"city\": \"Tyler\",\r\n \"state\": \"TX\",\r\n \"zip\": \"75701\",\r\n \"phone\": \"111111111\",\r\n \"email\": \"support@onlinecheckwriter.com\",\r\n \"shippingTypeId\": 3,\r\n \"attachmentUrl\": \"https://www.onlinecheckwriter.com/samples/invoice/invoicesample.pdf\",\r\n \"attachmentTitle\": \"Invoice 1244\",\r\n \"fromAddress\": {\r\n \"name\": \"David Abraham\",\r\n \"company\": \"David LLC\",\r\n \"address1\": \"450 Sutter Street\",\r\n \"address2\": \"\",\r\n \"city\": \"San Francisco\",\r\n \"state\": \"CA\",\r\n \"zip\": \"94108\",\r\n \"phone\": \"987564128\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/quickpay/mailpdf"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"success\": true,\r\n \"data\": {\r\n \"id\": \"pNlkQ4rzd4wnOV0\",\r\n \"title\": \"Invoice 1244\",\r\n \"status\": \"Pending\",\r\n \"shippingType\": 3,\r\n \"toAddress\": {\r\n \"id\": \"rWQ8GpJPkAjD0Zz\",\r\n \"name\": \"New Payee\",\r\n \"company\": \"Tyler Payment Technologist\",\r\n \"phone\": \"111111111\",\r\n \"email\": \"support@onlinecheckwriter.com\",\r\n \"address1\": \"5007 richmond rd\",\r\n \"address2\": \"\",\r\n \"city\": \"Tyler\",\r\n \"state\": \"TX\",\r\n \"zip\": \"75701\",\r\n \"country\": null\r\n },\r\n \"fromAddress\": {\r\n \"id\": \"w6YmZjq0Pe5MXrx\",\r\n \"name\": \"David Abraham\",\r\n \"address1\": \"450 Sutter Street\",\r\n \"address2\": \"\",\r\n \"city\": \"San Francisco\",\r\n \"state\": \"CA\",\r\n \"zip\": \"94108\",\r\n \"phone\": \"987564128\",\r\n \"country\": \"US\"\r\n }\r\n }\r\n}"}],"_postman_id":"2ce9b038-668d-44f4-9715-c15a44cdd19b"}],"id":"61769b23-c695-4ec4-8bd1-c7eb7316cc8c","description":"Visit the specified URL to obtain your Account ID/Bank Account ID. If you continue to experience issues, our 'Getting Started' guide is available for further assistance.
\nLive Server : https://live.onlinecheckwriter.com/manage/developer/index
\nSandbox Server : https://sandbox.onlinecheckwriter.com/manage/developer/index
\n","_postman_id":"61769b23-c695-4ec4-8bd1-c7eb7316cc8c"},{"name":"Bank Account","item":[{"name":"Retrieve all bank accounts","event":[{"listen":"test","script":{"id":"161b5578-8810-4d47-9754-da914b870633","exec":["const resp = pm.response.json();\r","\r","\r","if(pm.response.code==200 && resp.success == true){\r","\r"," pm.environment.set(\"bankAccountId\", resp.data.bankAccounts[0].bankAccountId);\r","\r","}\r","if(pm.response.code==201 && resp.success == true){\r","\r"," pm.environment.set(\"bankAccountId\", resp.data.bankAccounts[0].bankAccountId);\r","\r","}\r",""],"type":"text/javascript"}}],"id":"bd910f25-39f1-41b1-8964-93897cea9584","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{AUTH_TOKEN}}"},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"Bearer {{AUTH_TOKEN}} ","warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman."},{"key":"Accept","type":"text","value":"application/json"}],"url":"{{BASE_URL}}/bankAccounts?perPage=&page=&term=","description":"List all bank account records.
\nQuery parameters
\nperPage | Number of records that you want to receive in the response,By default 10 records will be |
page | For navigating through pages ,By default first page will be listed |
term | Filter records by using any keywords |
Number of records that you want to receive in the response,By default 10 records will be listed
\n","type":"text/plain"},"key":"perPage","value":""},{"description":{"content":"By default first page will be listed
\n","type":"text/plain"},"key":"page","value":""},{"description":{"content":"Filter records by using any keywords
\n","type":"text/plain"},"key":"term","value":""}],"variable":[]}},"response":[{"id":"496310e0-0282-4aab-a3be-e7f28764efdc","name":"Retrieve all bank accounts","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{AUTH_TOKEN}} ","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{BASE_URL}}/bankAccounts?perPage&page&term","host":["{{BASE_URL}}"],"path":["bankAccounts"],"query":[{"key":"perPage","value":null},{"key":"page","value":null},{"key":"term","value":null}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8000"},{"key":"Date","value":"Thu, 15 Oct 2020 11:14:43 GMT"},{"key":"Date","value":"Thu, 15 Oct 2020 11:14:43 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.3.11"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"40"},{"key":"phpdebugbar-id","value":"Xf281b90ef7bd07bec9bfb853174aa8ab"}],"cookie":[],"responseTime":null,"body":" {\n \"success\": true,\n \"data\": {\n \"meta\": {\n \"total\": 2,\n \"currentPage\": 1,\n \"perPage\": 10\n },\n \"bankAccounts\": [\n {\n \"bankAccountId\": \"RYkWx8ePPNMKeK2Xz05\",\n \"name\": \"Demo Bank Account 1\",\n \"nickName\": \"Demo Bank Account 1\",\n \"accountNumber\": \"78978900\",\n \"bankId\": \"dqyYjOWOv3jRJol\",\n \"addressLine1\": \"1111 Franklin Avenue\",\n \"addressLine2\": null,\n \"city\": \"Garden City\",\n \"state\": \"NY\",\n \"zip\": \"11530-1617\",\n \"phone\": null,\n \"isVerified\": true,\n \"isAchEnabled\": false,\n \"createdDate\": \"02-27-2026\",\n \"webUrl\": \"{{BASE_URL}}/manage/bank-accounts/index?id=kWx8ePPNMKeK2Xz\"\n },\n {\n \"bankAccountId\": \"xQkY2VjXWXz8eNEmJ78\",\n \"name\": \"Demo Bank Account 2\",\n \"nickName\": \"Demo Bank Account 2\",\n \"accountNumber\": \"111111111111\",\n \"bankId\": \"xZqXGK2xEz4RzVv\",\n \"addressLine1\": \"1111 Franklin Avenue\",\n \"addressLine2\": null,\n \"city\": \"Garden City\",\n \"state\": \"NY\",\n \"zip\": \"11530-1617\",\n \"phone\": null,\n \"isVerified\": true,\n \"isAchEnabled\": true,\n \"createdDate\": \"02-27-2026\",\n \"webUrl\": \"{{BASE_URL}}/manage/bank-accounts/index?id=kY2VjXWXz8eNEmJ\"\n }\n ]\n }\n}"}],"_postman_id":"bd910f25-39f1-41b1-8964-93897cea9584"},{"name":"Retrieve check design templates","event":[{"listen":"test","script":{"id":"161b5578-8810-4d47-9754-da914b870633","exec":["const resp = pm.response.json();\r","\r","\r","if(pm.response.code==200 && resp.success == true){\r","\r"," pm.environment.set(\"bankAccountId\", resp.data.bankAccounts[0].bankAccountId);\r","\r","}\r","if(pm.response.code==201 && resp.success == true){\r","\r"," pm.environment.set(\"bankAccountId\", resp.data.bankAccounts[0].bankAccountId);\r","\r","}\r",""],"type":"text/javascript","packages":{}}}],"id":"17c13d68-fd1d-485b-ab71-3d5476c38e70","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{AUTH_TOKEN}}"},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{AUTH_TOKEN}} ","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"{{BASE_URL}}/bankAccounts/templates","description":"List all check design templates
\n","urlObject":{"path":["bankAccounts","templates"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"190b41e2-5fa6-4269-9146-0b467411150d","name":"Retrieve all templates","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{AUTH_TOKEN}} ","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"{{BASE_URL}}/bankAccounts/templates"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8000"},{"key":"Date","value":"Thu, 15 Oct 2020 11:14:43 GMT"},{"key":"Date","value":"Thu, 15 Oct 2020 11:14:43 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.3.11"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"40"},{"key":"phpdebugbar-id","value":"Xf281b90ef7bd07bec9bfb853174aa8ab"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": \"qx5NrWjymj2n3l6\",\n \"category_name\": \"Payroll Check\",\n \"design_name\": \"payroll-final\",\n \"image\": \"https://ocw-local-s3.s3.amazonaws.com/3/payroll-final.png\",\n \"premium\": false,\n \"price\": \"0.00\"\n },\n {\n \"id\": \"rz6VoW41dj589lK\",\n \"category_name\": \"Personal Checks\",\n \"design_name\": \"personal-final\",\n \"image\": \"https://ocw-local-s3.s3.amazonaws.com/2/personal-final.png\",\n \"premium\": false,\n \"price\": \"0.00\"\n },\n {\n \"id\": \"OYxZqXGKdeRzVvJ\",\n \"category_name\": \"Business Checks\",\n \"design_name\": \"Business checks two\",\n \"image\": \"https://ocw-local-s3.s3.amazonaws.com/1/Business%20checks%20two.png\",\n \"premium\": true,\n \"price\": \"0.50\"\n }\n ]\n}"}],"_postman_id":"17c13d68-fd1d-485b-ab71-3d5476c38e70"},{"name":"Retrieve a bank account","id":"b617dc4c-7104-4323-9f79-74570be34ea6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{AUTH_TOKEN}}"},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{AUTH_TOKEN}} ","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{BASE_URL}}/bankAccounts/{bankAccountId}","description":"Details of an existing bank account.
\nPath parameters
\nbankAccountId | Required The id of the Bank account to be retrieved. |
Delete an existing bank account.
\nPath parameters
\n| bankAccountId | \nRequired \n The id of the Bank account to be deleted. \n |
Update an existing bank account
\nPath parameters
\n| bankAccountId | \nRequired \n The id of the Bank account to update. \n |
Payload parameters
\n| name | \nRequired\n String \n The name of the bank account,Must be no longer than 100 characters. \n | \n
| nickName | \n Optional \n String \n Nick name that identifies this bank account. Must be no longer than 100 characters. \n | \n
| accountNumber | \nRequired \n String\n Must be no longer than 20 characters,This will be ignored if bank account is verified \n | \n
| addressLine1 | \nRequired \n String\n Address line 1 for bank account ,Must be no longer than 180 characters. \n | \n
| addressLine2 | \n Optional \n String \n Address line 2 for bank account ,Must be no longer than 180 characters. \n | \n
| phone | \n Optional \n String \n Must be no longer than 15 characters. \n | \n
| city | \n Required \n String \n Name of the city \n | \n
| state | \n Required \n String \n Name of the state \n | \n
| zip | \nRequired \n String \n valid zip code \n | \n
You can create multiple bank accounts in one single request by passing bank accounts attributes.
\nPayload parameters
\nbankAccounts | Required An array of |
_bankaccount_ attributes
name | Required The name of the bank account,Must be no longer than 100 characters. |
nickName | Optional Nick name that identifies this bank account. Must be no longer than 100 characters. |
accountNumber | Required Must be no longer than 20 characters. |
addressLine1 | Required Address line 1 for bank account ,Must be no longer than 180 characters. |
addressLine2 | Optional Address line 2 for bank account ,Must be no longer than 180 characters. |
phone | Optional Must be no longer than 15 characters. |
city | Required The name of the city. |
State | Required The name of the State. |
zip | Required Zip of bank account |
bankName | Optional The name of the bank,Must be no longer than 100 characters. |
bankRoutingNumber | Required Must be a valid US routing number of 9 characters. |
bankAddress1 | Optional Address line 2 for bank ,Must be no longer than 180 characters. |
bankCity | Optional City of bank |
bankState | Optional State of bank |
bankZip | Optional Zip of bank |
templateId | Optional String Associate check design template Id |
Accepted file types are PNG,JPG and JPEG
\n","fileNotInWorkingDirectoryWarning":"This file isn't in your working directory. Teammates you share this request with won't be able to use this file. To make collaboration easier you can setup your working directory in Settings.","filesNotInWorkingDirectory":["/C:/Users/Tyler/Downloads/sample.pdf"],"src":"/C:/Users/Tyler/Downloads/sample.pdf"},{"key":"nickName","value":"signature 1","description":"The nick name of the signature
\n","type":"text"}]},"url":"{{BASE_URL}}/bankAccounts/{bankAccountId}/signatures","description":"Add signature to existing bank account
\nPath parameters
\nbankAccountId | Required The id of the Bank account to update. |
Payload parameters
\nsignature | Required Accepted file types are PNG,JPG and JPEG and must be no more than 40960Kb |
nickName | Optional String The nick name of the signature,Must be no longer than 20 characters. |
Add signature to existing bank account
\nPath parameters
\nbankAccountId | Required The id of the Bank account to update. |
Add logo to existing bank account
\nPath parameters
\n| bankAccountId | \nRequired \n The id of the Bank account to update. \n |
Payload parameters
\n| logo | \nRequired \n File\n Accepted file types are PNG,JPG and JPEG and must be no more than 40960Kb \n |
The API provides endpoints for creating multiple bank accounts, retrieving individual bank accounts, deleting bank accounts,updating bank account and retrieving a list of bank account.
\n","_postman_id":"62377015-e363-4225-9175-a59be4199ead"},{"name":"Wallet","item":[{"name":"Withdraw Fund","item":[{"name":"Withdraw by ACH","item":[{"name":"Initiate ACH Withdrawal","id":"fb7a1d8b-28f9-4833-9ea1-6acb52f488bd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{AUTH_TOKEN}}"},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"fromWallet\": \"ea85fdfe-1e6b-4be6-8245-28bd3543777b\",\r\n \"toBankAccountId\": \"QaMdjZlvELGzLxb\",\r\n \"amount\": \"15.25\",\r\n \"description\": \"wallet withdrawel\",\r\n \"isSameDay\": 0\r\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/wallet/withdraw/ach/initiate","urlObject":{"path":["wallet","withdraw","ach","initiate"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"00a7892a-581c-4131-940c-048e6294cb7f","name":"Initaite Withdraw Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"fromWallet\": \"ea85fdfe-1e6b-4be6-8245-28bd3543777b\",\r\n \"toBankAccountId\": \"QaMdjZlvELGzLxb\",\r\n \"amount\": \"15.25\",\r\n \"description\": \"wallet withdrawel\",\r\n \"isSameDay\": 0\r\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/wallet/withdraw/ach/initiate"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"success\": true,\r\n \"data\": {\r\n \"id\": \"5c04a346-00db-48bb-bb5d-b1e06165eac0\",\r\n \"fromWallet\" :\"ea85fdfe-1e6b-4be6-8245-28bd3543777b\",\r\n \"bankAccountId\": \"KmQaMdjZlvELGzLxbWy\",\r\n \"amount\": \"15.25\",\r\n \"description\": \"wallet withdrawel\",\r\n \"status\": \"PENDING\",\r\n \"updatedAt\": \"2023-10-25T07:43:27.000000Z\",\r\n \"createdAt\": \"2023-10-25T07:43:27.000000Z\"\r\n }\r\n}"},{"id":"07b03a44-2695-422d-b486-f8d07eb29b72","name":"Webhook : wallet.withdraw.ach.initiated","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":""},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"event\": {\r\n \"type\": \"wallet.withdraw.ach.initiated\",\r\n \"data\": {\r\n \"id\": \"58216187-46ce-4942-9658-5dffed3fdc2a\",\r\n\t\t\t\t\t\t\"fromWallet\" :\"ea85fdfe-1e6b-4be6-8245-28bd3543777b\",\r\n \"bankAccountId\": \"6azRNXG0RL1ljLxyBb3\",\r\n \"amount\": \"120.25\",\r\n \"description\": \"wallet withdrawal\",\r\n \"status\": \"PENDING\",\r\n \"updatedAt\": \"2024-10-21T07:19:12.000000Z\",\r\n \"createdAt\": \"2024-10-21T07:19:12.000000Z\"\r\n },\r\n \"id\": \"c421306d-9b95-46b9-b219-7d398e8171f1\",\r\n \"createdAt\": \"2024-10-21T07:19:12.000000Z\"\r\n }\r\n}"},{"id":"87bd5308-f1f2-418e-b28f-977682fa87e3","name":"Webhook : wallet.withdraw.ach.updated","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":""},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"event\": {\r\n \"type\": \"wallet.withdraw.ach.updated\",\r\n \"data\": {\r\n \"id\": \"58216187-46ce-4942-9658-5dffed3fdc2a\",\r\n\t\t\t\t\t \"fromWallet\" :\"ea85fdfe-1e6b-4be6-8245-28bd3543777b\",\r\n \"bankAccountId\": \"6azRNXG0RL1ljLxyBb3\",\r\n \"amount\": \"120.25\",\r\n \"description\": \"wallet withdrawel\",\r\n \"status\": \"PROCESSING\",\r\n \"updatedAt\": \"2024-10-21T07:19:13.000000Z\",\r\n \"createdAt\": \"2024-10-21T07:19:12.000000Z\"\r\n },\r\n \"id\": \"986de175-2b52-4385-8a78-ca1b14e213ba\",\r\n \"createdAt\": \"2024-10-21T07:19:13.000000Z\"\r\n }\r\n}"}],"_postman_id":"fb7a1d8b-28f9-4833-9ea1-6acb52f488bd"},{"name":"Retrieve ACH Withdrawal","id":"565a4939-7459-4224-bc9f-d0ba2c06ed9f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{AUTH_TOKEN}}"},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"{{BASE_URL}}/wallet/withdraw/ach/5c04a346-00db-48bb-bb5d-b1e06165eac0","urlObject":{"path":["wallet","withdraw","ach","5c04a346-00db-48bb-bb5d-b1e06165eac0"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"4716f765-8c84-4e09-b895-bbc3d527474c","name":"Withdraw-fund-details","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"{{BASE_URL}}/wallet/withdraw/ach/5c04a346-00db-48bb-bb5d-b1e06165eac0"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"success\": true,\r\n \"data\": {\r\n \"id\": \"5c04a346-00db-48bb-bb5d-b1e06165eac0\",\r\n\t\t\t\t\"fromWallet\" :\"ea85fdfe-1e6b-4be6-8245-28bd3543777b\",\r\n \"bankAccountId\": \"KmQaMdjZlvELGzLxbWy\",\r\n \"amount\": \"15.25\",\r\n \"description\": \"wallet withdrawel\",\r\n \"status\": \"PROCESSING\",\r\n \"updatedAt\": \"2023-10-25T07:43:27.000000Z\",\r\n \"createdAt\": \"2023-10-25T07:43:27.000000Z\"\r\n }\r\n}"}],"_postman_id":"565a4939-7459-4224-bc9f-d0ba2c06ed9f"},{"name":"List ACH Withdrawals","id":"f090d7b4-6466-44be-a5f6-3bb1639967fa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{AUTH_TOKEN}}"},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"{{BASE_URL}}/wallet/withdraw/ach?limit=2","urlObject":{"path":["wallet","withdraw","ach"],"host":["{{BASE_URL}}"],"query":[{"key":"limit","value":"2"}],"variable":[]}},"response":[{"id":"c08d6368-ba94-419f-bd68-cfaee5b00637","name":"Withdraw-fund-list","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{BASE_URL}}/wallet/withdraw/ach?limit=2","host":["{{BASE_URL}}"],"path":["wallet","withdraw","ach"],"query":[{"key":"limit","value":"2"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"success\": true,\r\n \"meta\": {\r\n \"total\": 2,\r\n \"perPage\": \"2\",\r\n \"currentPage\": 1,\r\n \"lastPage\": 1\r\n },\r\n \"data\": [\r\n {\r\n \"id\": \"963008f3-b085-4060-8580-b9d2d6bd39ce\",\r\n\t\t\t\t\t\t\"fromWallet\" :\"ea85fdfe-1e6b-4be6-8245-28bd3543777b\",\r\n \"bankAccountId\": \"KmQaMdjZlvELGzLxbWy\",\r\n \"amount\": \"19.50\",\r\n \"description\": \"wallet withdrawel 2\",\r\n \"status\": \"PROCESSING\",\r\n \"updatedAt\": \"2023-10-25T07:45:07.000000Z\",\r\n \"createdAt\": \"2023-10-25T07:45:06.000000Z\"\r\n },\r\n {\r\n \"id\": \"5c04a346-00db-48bb-bb5d-b1e06165eac0\",\r\n\t\t\t\t\t\t\"fromWallet\" :\"ea85fdfe-1e6b-4be6-8245-28bd3543777b\",\r\n \"bankAccountId\": \"KmQaMdjZlvELGzLxbWy\",\r\n \"amount\": \"15.25\",\r\n \"description\": \"wallet withdrawel\",\r\n \"status\": \"PROCESSING\",\r\n \"updatedAt\": \"2023-10-25T07:43:27.000000Z\",\r\n \"createdAt\": \"2023-10-25T07:43:27.000000Z\"\r\n }\r\n ]\r\n}"}],"_postman_id":"f090d7b4-6466-44be-a5f6-3bb1639967fa"}],"id":"8d101c0d-b440-4ae9-93b4-8e9de97df61c","_postman_id":"8d101c0d-b440-4ae9-93b4-8e9de97df61c","description":""},{"name":"Withdraw by Wire Transfer","item":[{"name":"Initiate Wire Withdrawal","id":"9af1e955-5f69-45f1-9448-6330b078d2f7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{AUTH_TOKEN}}"},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"fromWallet\": \"dd55fcc4-84a6-400b-b033-c7b2520c7963\",\r\n \"toBankAccountId\": \"5EJy7VeBw8yQjzn1m39\",\r\n \"amount\": \"35.53\",\r\n \"description\": \"Wallet withdrawal\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/wallet/withdraw/wire/initiate","urlObject":{"path":["wallet","withdraw","wire","initiate"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"468971bd-7928-4340-97f0-ba7795dd7c01","name":"Initiate Wire Withdrawal","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"fromWallet\": \"dd55fcc4-84a6-400b-b033-c7b2520c7963\",\r\n \"toBankAccountId\": \"5EJy7VeBw8yQjzn1m39\",\r\n \"amount\": \"35.53\",\r\n \"description\": \"Wallet withdrawal\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/wallet/withdraw/wire/initiate"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Wed, 12 Mar 2025 09:49:01 GMT"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"phpdebugbar-id","value":"Xdf85ed2e45b1a374ec927eb01fc64d92"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Frame-Options","value":"ALLOWALL"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": \"76e10e55-34ff-444b-a72b-b03e45d430d9\",\n \"fromWallet\": \"dd55fcc4-84a6-400b-b033-c7b2520c7963\",\n \"toBankAccount\": \"Jy7VeBw8yQjzn1m\",\n \"amount\": \"25.54\",\n \"description\": \"Wallet withdrawal\",\n \"status\": \"PENDING\",\n \"updatedAt\": \"2025-03-12T09:49:00.000000Z\",\n \"createdAt\": \"2025-03-12T09:49:00.000000Z\"\n }\n}"},{"id":"3766bbcb-1bd2-46f4-ae1b-cf5ab4ada14d","name":"Webhook : wallet.withdraw.wire.initiated","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":""},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"event\": {\r\n \"type\": \"wallet.withdraw.wire.initiated\",\r\n \"data\": {\r\n \"id\": \"97e49c39-f141-48c7-a8c2-248507f43a87\",\r\n \"fromWallet\": \"dd55fcc4-84a6-400b-b033-c7b2520c7963\",\r\n \"toBankAccount\": \"Jy7VeBw8yQjzn1m\",\r\n \"amount\": \"50.01\",\r\n \"description\": \"Wallet withdrawal\",\r\n \"status\": \"PENDING\",\r\n \"updatedAt\": \"2025-03-14T09:46:43.000000Z\",\r\n \"createdAt\": \"2025-03-14T09:46:43.000000Z\"\r\n },\r\n \"id\": \"45eddb32-cb82-45a3-983d-963a9976df21\",\r\n \"createdAt\": \"2025-03-14T09:46:43.000000Z\"\r\n }\r\n}"},{"id":"cf251f26-af3d-4ea8-b220-d4b12a494137","name":"Webhook : wallet.withdraw.wire.updated","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":""},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"event\": {\r\n \"type\": \"wallet.withdraw.wire.updated\",\r\n \"data\": {\r\n \"id\": \"97e49c39-f141-48c7-a8c2-248507f43a87\",\r\n \"fromWallet\": \"dd55fcc4-84a6-400b-b033-c7b2520c7963\",\r\n \"toBankAccount\": \"Jy7VeBw8yQjzn1m\",\r\n \"amount\": \"50.01\",\r\n \"description\": \"Wallet withdrawal\",\r\n \"status\": \"PROCESSING\",\r\n \"updatedAt\": \"2025-03-14T09:46:43.000000Z\",\r\n \"createdAt\": \"2025-03-14T09:46:43.000000Z\"\r\n },\r\n \"id\": \"d9560ca2-b29c-4e56-a153-20e6560dd4d4\",\r\n \"createdAt\": \"2025-03-14T09:46:43.000000Z\"\r\n }\r\n}"},{"id":"bfeed409-7526-48b7-8c0f-5a146d8bd7d3","name":"Webhook : wallet.withdraw.wire.updated","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":""},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"event\": {\r\n \"type\": \"wallet.withdraw.wire.updated\",\r\n \"data\": {\r\n \"id\": \"97e49c39-f141-48c7-a8c2-248507f43a87\",\r\n \"fromWallet\": \"dd55fcc4-84a6-400b-b033-c7b2520c7963\",\r\n \"toBankAccount\": \"Jy7VeBw8yQjzn1m\",\r\n \"amount\": \"50.01\",\r\n \"description\": \"Wallet withdrawal\",\r\n \"status\": \"COMPLETED\",\r\n \"updatedAt\": \"2025-03-14T09:53:19.000000Z\",\r\n \"createdAt\": \"2025-03-14T09:46:43.000000Z\"\r\n },\r\n \"id\": \"5a1d03ee-cde0-4074-b04c-7e86113bbde6\",\r\n \"createdAt\": \"2025-03-14T09:53:19.000000Z\"\r\n }\r\n}"}],"_postman_id":"9af1e955-5f69-45f1-9448-6330b078d2f7"},{"name":"Retrieve Wire Withdrawal","id":"3d95cab8-156c-4deb-ac92-aa20ea465054","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{AUTH_TOKEN}}"},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"{{BASE_URL}}/wallet/withdraw/wire/56a27cc0-2d81-4bb3-97ce-5bec55104626","urlObject":{"path":["wallet","withdraw","wire","56a27cc0-2d81-4bb3-97ce-5bec55104626"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"747a508d-9eb0-4ea7-85d3-9e195206bff4","name":"Retrieve Wire Withdrawal","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"{{BASE_URL}}/wallet/withdraw/wire/56a27cc0-2d81-4bb3-97ce-5bec55104626"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Wed, 12 Mar 2025 10:04:29 GMT"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"phpdebugbar-id","value":"X301f5ea78b80c073ec830d98f57ebdc8"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Frame-Options","value":"ALLOWALL"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": \"56a27cc0-2d81-4bb3-97ce-5bec55104626\",\n \"fromWallet\": \"dd55fcc4-84a6-400b-b033-c7b2520c7963\",\n \"toBankAccount\": \"Jy7VeBw8yQjzn1m\",\n \"amount\": \"15.01\",\n \"description\": \"wallet withdrawal 2\",\n \"status\": \"PROCESSING\",\n \"updatedAt\": \"2025-03-12T09:56:14.000000Z\",\n \"createdAt\": \"2025-03-12T09:56:14.000000Z\"\n }\n}"}],"_postman_id":"3d95cab8-156c-4deb-ac92-aa20ea465054"},{"name":"List Wire Withdrawal","id":"9297e80d-bf83-4eb2-8ea2-99fe71ad4057","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{AUTH_TOKEN}}"},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"","urlObject":{"query":[],"variable":[]}},"response":[{"id":"3471635a-2513-4eda-b968-6bb60a49b5e1","name":"List Wire Withdrwal","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"{{BASE_URL}}/wallet/withdraw/wire"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Wed, 12 Mar 2025 09:57:55 GMT"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"phpdebugbar-id","value":"Xe9cfd232b68be67dc8de4696ebe30cf7"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Frame-Options","value":"ALLOWALL"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"meta\": {\n \"total\": 4,\n \"perPage\": 10,\n \"currentPage\": 1,\n \"lastPage\": 1\n },\n \"data\": [\n {\n \"id\": \"56a27cc0-2d81-4bb3-97ce-5bec55104626\",\n \"fromWallet\": \"dd55fcc4-84a6-400b-b033-c7b2520c7963\",\n \"toBankAccount\": \"Jy7VeBw8yQjzn1m\",\n \"amount\": \"15.01\",\n \"description\": \"wallet withdrawal 2\",\n \"status\": \"PROCESSING\",\n \"updatedAt\": \"2025-03-12T09:56:14.000000Z\",\n \"createdAt\": \"2025-03-12T09:56:14.000000Z\"\n },\n {\n \"id\": \"76e10e55-34ff-444b-a72b-b03e45d430d9\",\n \"fromWallet\": \"dd55fcc4-84a6-400b-b033-c7b2520c7963\",\n \"toBankAccount\": \"Jy7VeBw8yQjzn1m\",\n \"amount\": \"25.54\",\n \"description\": \"Wallet withdrawal\",\n \"status\": \"PROCESSING\",\n \"updatedAt\": \"2025-03-12T09:49:00.000000Z\",\n \"createdAt\": \"2025-03-12T09:49:00.000000Z\"\n }\n ]\n}"}],"_postman_id":"9297e80d-bf83-4eb2-8ea2-99fe71ad4057"}],"id":"779fcb7c-37fd-4d4a-9bec-75f397fab183","_postman_id":"779fcb7c-37fd-4d4a-9bec-75f397fab183","description":""},{"name":"Withdraw by Check Mail","item":[{"name":"Initiate Check Mail Withdrawal","id":"8723f2d5-8af4-4b9e-8978-52d7dfbec69d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{AUTH_TOKEN}}"},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"fromWallet\": \"86f24597-a2a4-489d-b18d-c2bfb9b8b452\",\r\n \"amount\": \"1.25\",\r\n \"description\": \"Wallet Withdraw :Mail\",\r\n \"customFromAddressId\" :\"5mQ0bRG2q4ZdP3x\" ,\r\n \"customToAddressId\" : \"VRdJM5Gb3eY329A\",\r\n \"shippingType\": \"FEDEX_NEXT_DAY_PM\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/wallet/withdraw/mail/initiate","description":"Payload Parameter
\nAvailable Shipping Types
\n","urlObject":{"path":["wallet","withdraw","mail","initiate"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"c1af86e1-f426-4a93-80b8-f29ac1a7cc6f","name":"Initaite Withdraw Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"fromWallet\": \"86f24597-a2a4-489d-b18d-c2bfb9b8b452\",\r\n \"amount\": \"1.25\",\r\n \"description\": \"Wallet Withdraw :Mail\",\r\n \"customFromAddressId\" :\"5mQ0bRG2q4ZdP3x\" ,\r\n \"customToAddressId\" : \"VRdJM5Gb3eY329A\",\r\n \"shippingType\": \"FEDEX_NEXT_DAY_PM\"\r\n\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/wallet/withdraw/mail/initiate"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"success\": true,\r\n \"data\": {\r\n \"id\": \"c6f98d19-4bd8-4a10-a758-05e0a9f2eabd\",\r\n \"fromWallet\": \"86f24597-a2a4-489d-b18d-c2bfb9b8b452\",\r\n \"amount\": \"1.25\",\r\n \"description\": \"Wallet Withdraw :Mail\",\r\n \"shippingType\": \"FEDEX_NEXT_DAY_PM\",\r\n \"status\": \"PENDING\",\r\n \"updatedAt\": \"2024-12-21T08:19:57.000000Z\",\r\n \"createdAt\": \"2024-12-21T08:19:57.000000Z\",\r\n \"fromAddress\": {\r\n \"name\": \"GolbalTech Solution\",\r\n \"addressLine1\": \"1234 East Elm Street\",\r\n \"addressLine2\": \"\",\r\n \"city\": \"Springfield\",\r\n \"state\": \"MO\",\r\n \"zip\": \"65802\"\r\n },\r\n \"toAddress\": {\r\n \"name\": \"John\",\r\n \"addressLine1\": \"4787 Rhode Island Avenue\",\r\n \"addressLine2\": \"\",\r\n \"city\": \"Springfield\",\r\n \"state\": \"MO\",\r\n \"zip\": \"65802\"\r\n }\r\n }\r\n}"},{"id":"5b1d9743-7dca-4853-84d1-bcdf2793aa0b","name":"Webhook : wallet.withdraw.check.mail.initiated","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":""},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"event\": {\r\n \"type\": \"wallet.withdraw.check.mail.initiated\",\r\n \"data\": {\r\n \"id\": \"b9267cd0-61e3-49c1-ac99-c55dc7fad757\",\r\n \"fromWallet\": \"dd55fcc4-84a6-400b-b033-c7b2520c7963\",\r\n \"amount\": \"42.00\",\r\n \"description\": \"Wallet Withdraw :Mail\",\r\n \"shippingType\": \"FEDEX_NEXT_DAY_PM\",\r\n \"shippingInfo\": {\r\n \"trackingNumber\": null,\r\n \"trackingUrl\": null\r\n },\r\n \"status\": \"PENDING\",\r\n \"updatedAt\": \"2025-03-17T06:05:32.000000Z\",\r\n \"createdAt\": \"2025-03-17T06:05:32.000000Z\",\r\n \"fromAddress\": {\r\n \"name\": \"Michael Johnson\",\r\n \"addressLine1\": \"1111 Franklin Avenue\",\r\n \"addressLine2\": \"\",\r\n \"city\": \"Garden City\",\r\n \"state\": \"NY\",\r\n \"zip\": \"11530\"\r\n },\r\n \"toAddress\": {\r\n \"name\": \"Emily Davis\",\r\n \"addressLine1\": \"1 Apple Park Way\",\r\n \"addressLine2\": \"\",\r\n \"city\": \"Cupertino\",\r\n \"state\": \"CA\",\r\n \"zip\": \"95014\"\r\n }\r\n },\r\n \"id\": \"987de275-3662-4000-933f-da23bafaadf7\",\r\n \"createdAt\": \"2025-03-17T06:05:32.000000Z\"\r\n }\r\n}"},{"id":"be64a2ea-74c6-4afb-95e3-65af62be4c99","name":"Webhook : wallet.withdraw.check.mail.updated","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":""},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":" {\r\n \"event\": {\r\n \"type\": \"wallet.withdraw.check.mail.updated\",\r\n \"data\": {\r\n \"id\": \"b9267cd0-61e3-49c1-ac99-c55dc7fad757\",\r\n \"fromWallet\": \"dd55fcc4-84a6-400b-b033-c7b2520c7963\",\r\n \"amount\": \"42.00\",\r\n \"description\": \"Wallet Withdraw :Mail\",\r\n \"shippingType\": \"FEDEX_NEXT_DAY_PM\",\r\n \"shippingInfo\": {\r\n \"trackingNumber\": null,\r\n \"trackingUrl\": null\r\n },\r\n \"status\": \"PROCESSING\",\r\n \"updatedAt\": \"2025-03-17T06:05:33.000000Z\",\r\n \"createdAt\": \"2025-03-17T06:05:32.000000Z\",\r\n \"fromAddress\": {\r\n \"name\": \"Michael Johnson\",\r\n \"addressLine1\": \"1111 Franklin Avenue\",\r\n \"addressLine2\": \"\",\r\n \"city\": \"Garden City\",\r\n \"state\": \"NY\",\r\n \"zip\": \"11530\"\r\n },\r\n \"toAddress\": {\r\n \"name\": \"Emily Davis\",\r\n \"addressLine1\": \"1 Apple Park Way\",\r\n \"addressLine2\": \"\",\r\n \"city\": \"Cupertino\",\r\n \"state\": \"CA\",\r\n \"zip\": \"95014\"\r\n }\r\n },\r\n \"id\": \"437c1ab2-7f46-494f-8bc3-10ad8a0fcf7a\",\r\n \"createdAt\": \"2025-03-17T06:05:33.000000Z\"\r\n }\r\n}"},{"id":"89c00e00-fd0a-4afe-82c7-04b1c63f5667","name":"Webhook : wallet.withdraw.check.mail.updated","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":""},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":" {\r\n \"event\": {\r\n \"type\": \"wallet.withdraw.check.mail.updated\",\r\n \"data\": {\r\n \"id\": \"b9267cd0-61e3-49c1-ac99-c55dc7fad757\",\r\n \"fromWallet\": \"dd55fcc4-84a6-400b-b033-c7b2520c7963\",\r\n \"amount\": \"42.00\",\r\n \"description\": \"Wallet Withdraw :Mail\",\r\n \"shippingType\": \"FEDEX_NEXT_DAY_PM\",\r\n \"shippingInfo\": {\r\n \"trackingNumber\": null,\r\n \"trackingUrl\": \"\"\r\n },\r\n \"status\": \"COMPLETED\",\r\n \"updatedAt\": \"2025-03-17T06:06:21.000000Z\",\r\n \"createdAt\": \"2025-03-17T06:05:32.000000Z\",\r\n \"fromAddress\": {\r\n \"name\": \"Michael Johnson\",\r\n \"addressLine1\": \"1111 Franklin Avenue\",\r\n \"addressLine2\": \"\",\r\n \"city\": \"Garden City\",\r\n \"state\": \"NY\",\r\n \"zip\": \"11530\"\r\n },\r\n \"toAddress\": {\r\n \"name\": \"Emily Davis\",\r\n \"addressLine1\": \"1 Apple Park Way\",\r\n \"addressLine2\": \"\",\r\n \"city\": \"Cupertino\",\r\n \"state\": \"CA\",\r\n \"zip\": \"95014\"\r\n }\r\n },\r\n \"id\": \"ce9f3ea7-2efb-4536-81a8-42c1a6c79717\",\r\n \"createdAt\": \"2025-03-17T06:06:21.000000Z\"\r\n }\r\n}"},{"id":"17c26e2a-7fe4-41ee-b493-8cfa55b43b85","name":"Webhook : wallet.withdraw.check.mail.updated","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":""},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":" {\r\n \"event\": {\r\n \"type\": \"wallet.withdraw.check.mail.updated\",\r\n \"data\": {\r\n \"id\": \"20d0936d-34b0-47fd-8b67-6e094c6e74eb\",\r\n \"fromWallet\": \"b6ae6c7d-d373-4e8f-a860-6638b22f5033\",\r\n \"amount\": \"55.00\",\r\n \"description\": \"Wallet Withdraw :Mail\",\r\n \"shippingType\": \"FEDEX_NEXT_DAY_PM\",\r\n \"shippingInfo\": {\r\n \"trackingNumber\": null,\r\n \"trackingUrl\": \"\"\r\n },\r\n \"status\": \"FAILED\",\r\n \"clearingFile\": null,\r\n \"previewFile\": null,\r\n \"reviewMessage\": \"Rejected as requested by the customer.\",\r\n \"updatedAt\": \"2025-12-19T09:31:09.000000Z\",\r\n \"createdAt\": \"2025-12-19T09:23:13.000000Z\",\r\n \"fromAddress\": {\r\n \"name\": \"Park Way Finance Office\",\r\n \"addressLine1\": \"1 Apple Park Way\",\r\n \"addressLine2\": \"\",\r\n \"city\": \"Cupertino\",\r\n \"state\": \"CA\",\r\n \"zip\": \"95014\"\r\n },\r\n \"toAddress\": {\r\n \"name\": \"Broadway Accounting Department\",\r\n \"addressLine1\": \"111 Broadway\",\r\n \"addressLine2\": \"\",\r\n \"city\": \"Paterson\",\r\n \"state\": \"NJ\",\r\n \"zip\": \"07502\"\r\n }\r\n },\r\n \"id\": \"0d75ae49-9000-4936-bd6a-a7a192a92cd7\",\r\n \"createdAt\": \"2025-12-19T09:31:09.000000Z\"\r\n }\r\n}"},{"id":"2a3a30e2-4dda-400f-95c3-f987520da88e","name":"Webhook : wallet.withdraw.check.mail.updated","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":""},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":" {\r\n \"event\": {\r\n \"type\": \"wallet.withdraw.check.mail.updated\",\r\n \"data\": {\r\n \"id\": \"95686456-3449-4603-a366-12c8f49f775a\",\r\n \"fromWallet\": \"b6ae6c7d-d373-4e8f-a860-6638b22f5033\",\r\n \"amount\": \"35.00\",\r\n \"description\": \"Wallet Withdraw :Mail\",\r\n \"shippingType\": \"FEDEX_NEXT_DAY_PM\",\r\n \"shippingInfo\": {\r\n \"trackingNumber\": null,\r\n \"trackingUrl\": \"\"\r\n },\r\n \"status\": \"RETURNED\",\r\n \"clearingFile\": null,\r\n \"previewFile\": \"https://ocw-local-s3.s3.amazonaws.com/checkmail/preview/preview-1177--1766139279.pdf?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential={{vault:aws-access-key}}%2F20251219%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=2Z&X-Amz-SignedHeaders=host&X-Amz-Expires=600&X-Amz-Signature=838eb26b58d7ba3120b825700e025058e7042f67aa53908dae4e665607211bc5\",\r\n \"reviewMessage\": \"Returned due to address not found by the mailing provider.\",\r\n \"updatedAt\": \"2025-12-19T10:14:40.000000Z\",\r\n \"createdAt\": \"2025-12-19T10:12:27.000000Z\",\r\n \"fromAddress\": {\r\n \"name\": \"Park Way Finance Office\",\r\n \"addressLine1\": \"1 Apple Park Way\",\r\n \"addressLine2\": \"\",\r\n \"city\": \"Cupertino\",\r\n \"state\": \"CA\",\r\n \"zip\": \"95014\"\r\n },\r\n \"toAddress\": {\r\n \"name\": \"Broadway Accounting Department\",\r\n \"addressLine1\": \"111 Broadway\",\r\n \"addressLine2\": \"\",\r\n \"city\": \"Paterson\",\r\n \"state\": \"NJ\",\r\n \"zip\": \"07502\"\r\n }\r\n },\r\n \"id\": \"dd281deb-3d4a-4c7e-8ef4-194f601901d3\",\r\n \"createdAt\": \"2025-12-19T10:14:40.000000Z\"\r\n }\r\n}\r\n"}],"_postman_id":"8723f2d5-8af4-4b9e-8978-52d7dfbec69d"},{"name":"Retrieve Check Mail Withdrawal","id":"41350bfb-8d25-43ea-b68b-acbcaff834c9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{AUTH_TOKEN}}"},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"{{BASE_URL}}/wallet/withdraw/mail/5c04a346-00db-48bb-bb5d-b1e06165eac0","description":"status :PENDING ,PROCESSING , COMPLETED,CANCELED,FAILED
STATUS AND DESCRIPTIONS
\nPENDING: Once the fund wallet request is created, the status will be PENDING.
\nPROCESSING: Once the request is created, the transaction will start to process, and the status will change to PROCESSING instantly.
\nCOMPLETED: Once the transaction process is successfully completed, the funds will be available in the wallet.
\nFAILED: When the transaction is rejected, failed, or returned during processing, the status will be FAILED.
\nRETURNED: After the funds are released, if the transaction is returned as an ACH return, the amount will be deducted from the wallet at this time.
\nAllowed TransferType : domestic-wire ,international-wire
Available Status :PENDING,COMPLETED , REJECTED
List all transactions of a wallet.
\nQuery parameters
\npage | For navigating through pages ,By default first page will be listed |
statusCode | Filter statements by statusCode |
term | Filter statements by using any keywords |
You can transfer funds from one wallet to another within the same account using this endpoint.
\n","urlObject":{"path":["wallet","internal-transfer"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"7989f9d1-1474-4181-b598-07077219f812","name":"Wallet Internal Transfer","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"fromWallet\": \"86f24597-a2a4-489d-b18d-c2bfb9b8b452\",\r\n \"toWallet\": \"4fa68199-1cf8-43c8-9df4-eb2b9ae20af7\",\r\n \"amount\": \"1.25\",\r\n \"description\": \"Transfer to second wallet\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/wallet/internal-transfer"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": \"6bb62abd-4a7c-4bed-b51f-4243da319733\",\n \"fromWallet\": \"86f24597-a2a4-489d-b18d-c2bfb9b8b452\",\n \"toWallet\": \"4fa68199-1cf8-43c8-9df4-eb2b9ae20af7\",\n \"amount\": \"1.25\",\n \"description\": \"Transfer to second wallet\",\n \"status\": \"COMPLETED\",\n \"updatedAt\": \"2024-10-17T11:24:41.000000Z\",\n \"createdAt\": \"2024-10-17T11:24:41.000000Z\"\n }\n}"}],"_postman_id":"f12fff02-8bb4-404a-9cb6-a2821cca9758"}],"id":"0403ff41-aea8-4b82-ad4d-95f8803fbb54","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"71d1d472-b5ac-498e-a6b1-9893c80d729c"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"a2fda779-46bd-4ebd-bd6b-8103f12a8ebd"}}],"_postman_id":"0403ff41-aea8-4b82-ad4d-95f8803fbb54","description":""},{"name":"Card Program","item":[{"name":"Wallet Spend Card","item":[{"name":"Create Virtual Card","id":"489f788f-e30c-472e-a1ec-fa30e2307e59","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{AUTH_TOKEN}}"},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"walletId\": \"dd55fcc4-84a6-400b-b033-c7b2520c7963\",\r\n \"limitAmount\": 100,\r\n \"nameOnCard\": \"Daniel Richardson\",\r\n \"label\": \"Daniel Richardson\",\r\n \"cardType\": \"virtual\",\r\n \"limitInterval\": \"monthly\",\r\n \"restrictionSettings\": {\r\n \"validTill\": \"2025-05-26\",\r\n \"allowedMerchantNames\": [\"amazon\", \"flipkart\", \"spotify\", \"ebay\", \"paypal\"],\r\n \"allowedMerchantCategoryCode\": [\"700\", \"3350\", \"7852\"],\r\n \"allowedMerchantCountry\": [\"US\", \"IN\"],\r\n \"allowedMerchantCity\": [\"newyork\", \"Chicago\"],\r\n \"allowedTime\": {\r\n \"timezone\": \"America/Chicago\",\r\n \"times\": [\r\n {\r\n \"from\": \"11:00\",\r\n \"to\": \"12:00\"\r\n },\r\n {\r\n \"from\": \"16:00\",\r\n \"to\": \"23:59\"\r\n }\r\n ]\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/card-program/card/create","description":"This API endpoint allows you to create a virtual or physical spend card linked to a specified wallet, with configurable spending limits and reset intervals for enhanced expense control.
\nPayload Parameters
\nrestrictionSettings Object
\n","urlObject":{"path":["card-program","card","create"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"a6fa671c-65b1-4d53-81d9-ef8077bf2801","name":"Create Vitual Card","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[],"options":{"raw":{"language":"json"}}},"url":{"raw":"{{BASE_URL}}/card-program/card/create","host":["{{BASE_URL}}"],"path":["card-program","card","create"],"query":[{"key":"","value":null,"disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Mon, 24 Mar 2025 07:58:28 GMT"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"phpdebugbar-id","value":"X284004a46aa137a3f514d4fa0eacde38"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Frame-Options","value":"ALLOWALL"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":" {\n \"success\": true,\n \"data\": {\n \"id\": \"3a0e6df8-36fa-4194-b12f-873b6c0ea39d\",\n \"walletId\": \"dd55fcc4-84a6-400b-b033-c7b2520c7963\",\n \"status\": \"PENDING\",\n \"card\": {\n \"id\": \"950902c6-110e-4a77-9eea-9802db41ae76\",\n \"cardProgramIssuingRecordId\": \"3a0e6df8-36fa-4194-b12f-873b6c0ea39d\",\n \"cardType\": \"virtual\",\n \"label\": \"Daniel Richardson\",\n \"nameOnCard\": \"Daniel Richardson\",\n \"limitAmount\": \"100.00\",\n \"limitInterval\": \"monthly\",\n \"last4\": \"1139\",\n \"cardStatus\": \"active\",\n \"expiryMonth\": \"9\",\n \"expiryYear\": \"2030\",\n \"cardIssueType\": \"WALLET_CARD\",\n \"wallet\": {\n \"id\": \"dd55fcc4-84a6-400b-b033-c7b2520c7963\",\n \"availableBalance\": \"36.07\",\n \"currentBalance\": \"46.07\",\n \"walletName\": \"Master Wallet\"\n },\n \"restrictionSettings\": {\n \"validTill\": \"2025-05-26\",\n \"allowedMerchantNames\": [\n \"amazon\",\n \"flipkart\",\n \"spotify\",\n \"ebay\",\n \"paypal\"\n ],\n \"allowedMerchantCategoryCode\": [\n \"700\",\n \"3350\",\n \"7852\"\n ],\n \"allowedMerchantCountry\": [\n \"US\",\n \"IN\"\n ],\n \"allowedMerchantCity\": [\n \"newyork\",\n \"Chicago\"\n ],\n \"allowedTime\": {\n \"timezone\": \"America/Chicago\",\n \"times\": [\n {\n \"from\": \"11:00\",\n \"to\": \"12:00\"\n },\n {\n \"from\": \"16:00\",\n \"to\": \"23:59\"\n }\n ]\n }\n }\n },\n \"updatedAt\": \"2025-03-27T11:31:44.000000Z\",\n \"createdAt\": \"2025-03-27T11:31:44.000000Z\"\n }\n}"},{"id":"86512190-4d2a-41a7-b30f-51d9d2c114be","name":"Webhook : card-program.card.created","originalRequest":{"method":"POST","header":[],"url":""},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":" {\n \"event\": {\n \"type\": \"card-program.card.created\",\n \"data\": {\n \"id\": \"ef5ea0cd-6b3e-4a74-b7b3-64ff86eef775\",\n \"walletId\": \"dd55fcc4-84a6-400b-b033-c7b2520c7963\",\n \"status\": \"PENDING\",\n \"card\": {\n \"id\": \"46d0c4d0-0d1c-438b-b793-84dd16bbd5fb\",\n \"cardProgramIssuingRecordId\": \"ef5ea0cd-6b3e-4a74-b7b3-64ff86eef775\",\n \"cardType\": \"virtual\",\n \"label\": \"Daniel Richardson\",\n \"nameOnCard\": \"Daniel Richardson\",\n \"limitAmount\": \"35.00\",\n \"limitInterval\": \"monthly\",\n \"last4\": \"8811\",\n \"cardStatus\": \"active\",\n \"expiryMonth\": \"5\",\n \"expiryYear\": \"2029\",\n \"cardIssueType\": \"WALLET_CARD\",\n \"wallet\": {\n \"id\": \"dd55fcc4-84a6-400b-b033-c7b2520c7963\",\n \"availableBalance\": \"36.07\",\n \"currentBalance\": \"46.07\",\n \"walletName\": \"Master Wallet\"\n },\n \"restrictionSettings\": {\n \"validTill\": \"2025-05-26\",\n \"allowedMerchantNames\": [\n \"amazon\",\n \"flipkart\",\n \"spotify\",\n \"ebay\",\n \"paypal\"\n ],\n \"allowedMerchantCategoryCode\": [\n \"700\",\n \"3350\",\n \"7852\"\n ],\n \"allowedMerchantCountry\": [\n \"US\",\n \"IN\"\n ],\n \"allowedMerchantCity\": [\n \"newyork\",\n \"Chicago\"\n ],\n \"allowedTime\": {\n \"timezone\": \"America/Chicago\",\n \"times\": [\n {\n \"from\": \"11:00\",\n \"to\": \"12:00\"\n },\n {\n \"from\": \"16:00\",\n \"to\": \"23:59\"\n }\n ]\n }\n }\n },\n \"updatedAt\": \"2025-03-27T11:29:40.000000Z\",\n \"createdAt\": \"2025-03-27T11:29:40.000000Z\"\n },\n \"id\": \"c649aee4-a78e-4bd6-9dec-5468966f84fb\",\n \"createdAt\": \"2025-03-27T11:29:48.000000Z\"\n }\n}"}],"_postman_id":"489f788f-e30c-472e-a1ec-fa30e2307e59"},{"name":"Create Physical Card","id":"7962a852-7527-4639-b7e2-5c02c7878285","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{AUTH_TOKEN}}"},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"walletId\": \"dd55fcc4-84a6-400b-b033-c7b2520c7963\",\r\n \"limitAmount\": 100,\r\n \"nameOnCard\": \"Daniel Richardson\",\r\n \"label\": \"Daniel Richardson\",\r\n \"cardType\": \"virtual\",\r\n \"limitInterval\": \"monthly\",\r\n \"restrictionSettings\": {\r\n \"validTill\": \"2025-05-26\",\r\n \"allowedMerchantNames\": [\"amazon\", \"flipkart\", \"spotify\", \"ebay\", \"paypal\"],\r\n \"allowedMerchantCategoryCode\": [\"700\", \"3350\", \"7852\"],\r\n \"allowedMerchantCountry\": [\"US\", \"IN\"],\r\n \"allowedMerchantCity\": [\"newyork\", \"Chicago\"],\r\n \"allowedTime\": {\r\n \"timezone\": \"America/Chicago\",\r\n \"times\": [\r\n {\r\n \"from\": \"11:00\",\r\n \"to\": \"12:00\"\r\n },\r\n {\r\n \"from\": \"16:00\",\r\n \"to\": \"23:59\"\r\n }\r\n ]\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/card-program/card/create","description":"This API endpoint allows you to create a virtual or physical spend card linked to a specified wallet, with configurable spending limits and reset intervals for enhanced expense control.
\nPayload Parameters
\nrestrictionSettings Object
\nAllowed shipping methods for physical cards
\n","urlObject":{"path":["card-program","card","create"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"02b656d1-ffee-4e8c-a740-9fe27d849254","name":"Create Physical Card","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"walletId\": \"deab2f42-8b8b-47ad-b766-eacc632df634\",\r\n \"limitAmount\": 100.00,\r\n \"limitInterval\": \"monthly\",\r\n \"nameOnCard\": \"Jane Smith\",\r\n \"label\": \"Gold Card\",\r\n \"cardType\": \"physical\",\r\n \"shippingAddress\": {\r\n \"line1\": \"456 Oak Street\",\r\n \"line2\": \"Suite 102\",\r\n \"city\": \"San Francisco\",\r\n \"state\": \"CA\",\r\n \"postal_code\": \"94110\",\r\n \"country\": \"US\",\r\n \"method\": \"standard\"\r\n },\r\n \"billingAddress\": {\r\n \"line1\": \"456 Oak Street\",\r\n \"line2\": \"Suite 102\",\r\n \"city\": \"San Francisco\",\r\n \"state\": \"CA\",\r\n \"postal_code\": \"94110\",\r\n \"country\": \"US\"\r\n }\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":{"raw":"{{BASE_URL}}/card-program/card/create","host":["{{BASE_URL}}"],"path":["card-program","card","create"],"query":[{"key":"","value":null,"disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Mon, 24 Mar 2025 07:58:28 GMT"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"phpdebugbar-id","value":"X284004a46aa137a3f514d4fa0eacde38"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Frame-Options","value":"ALLOWALL"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":" {\n \"success\": true,\n \"data\": {\n \"id\": \"96afd13e-dbcc-4179-8f61-1aab4e9f156a\",\n \"walletId\": \"deab2f42-8b8b-47ad-b766-eacc632df634\",\n \"status\": \"PENDING\",\n \"card\": {\n \"id\": \"ec459130-4aba-4ff2-b2f5-141908614f92\",\n \"cardProgramIssuingRecordId\": \"96afd13e-dbcc-4179-8f61-1aab4e9f156a\",\n \"cardType\": \"physical\",\n \"label\": \"Gold Card\",\n \"nameOnCard\": \"Jane Smith\",\n \"limitAmount\": \"100.00\",\n \"limitInterval\": \"monthly\",\n \"last4\": \"0940\",\n \"cardStatus\": \"pending_activation\",\n \"expiryMonth\": \"4\",\n \"expiryYear\": \"2030\",\n \"cardIssueType\": \"WALLET_CARD\",\n \"wallet\": {\n \"id\": \"deab2f42-8b8b-47ad-b766-eacc632df634\",\n \"availableBalance\": \"4644227.77\",\n \"currentBalance\": \"4666255.11\",\n \"walletName\": \"Master Wallet\"\n },\n \"restrictionSettings\": []\n },\n \"updatedAt\": \"2025-09-03T09:22:02.000000Z\",\n \"createdAt\": \"2025-09-03T09:22:02.000000Z\"\n }\n}"},{"id":"3942d1a2-7ab5-42ca-aa5b-c170b021323e","name":"Webhook : card-program.card.created","originalRequest":{"method":"POST","header":[],"url":""},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"event\": {\n \"type\": \"card-program.card.created\",\n \"data\": {\n \"id\": \"9b88f8ca-f01f-49ab-803a-7646d39f2a0d\",\n \"walletId\": \"deab2f42-8b8b-47ad-b766-eacc632df634\",\n \"status\": \"PENDING\",\n \"card\": {\n \"id\": \"58a79f17-95fc-4d08-aec7-0b39d059cf93\",\n \"cardProgramIssuingRecordId\": \"9b88f8ca-f01f-49ab-803a-7646d39f2a0d\",\n \"cardType\": \"physical\",\n \"label\": \"Gold Card\",\n \"nameOnCard\": \"Jane Smith\",\n \"limitAmount\": \"100.00\",\n \"limitInterval\": \"monthly\",\n \"last4\": \"3985\",\n \"cardStatus\": \"pending_activation\",\n \"expiryMonth\": \"1\",\n \"expiryYear\": \"2031\",\n \"cardIssueType\": \"WALLET_CARD\",\n \"wallet\": {\n \"id\": \"deab2f42-8b8b-47ad-b766-eacc632df634\",\n \"availableBalance\": \"4644220.77\",\n \"currentBalance\": \"4666248.11\",\n \"walletName\": \"Master Wallet\"\n },\n \"restrictionSettings\": []\n },\n \"updatedAt\": \"2025-09-03T09:35:26.000000Z\",\n \"createdAt\": \"2025-09-03T09:35:26.000000Z\"\n },\n \"id\": \"f6577020-018c-44ce-97b8-eab7072c20de\",\n \"createdAt\": \"2025-09-03T09:35:33.000000Z\"\n }\n}"}],"_postman_id":"7962a852-7527-4639-b7e2-5c02c7878285"},{"name":"Retrieve Wallet Spend Card","id":"707f8d40-a821-4735-905d-e46b019481f0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{AUTH_TOKEN}}"},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"{{BASE_URL}}/card-program/card/76691fcf-e535-4128-a81e-25874268ec32","description":"Retrieves the details of a specific spend card using its unique ID.
\n","urlObject":{"path":["card-program","card","76691fcf-e535-4128-a81e-25874268ec32"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"ec6c1973-4b34-4b42-8897-c5d941c7e67e","name":"Retrieve Wallet Credit Card","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"{{BASE_URL}}/card-program/card/76691fcf-e535-4128-a81e-25874268ec32"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Mon, 24 Mar 2025 08:00:06 GMT"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"phpdebugbar-id","value":"X6df551b9f5cb33016d530a016a1e71a1"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Frame-Options","value":"ALLOWALL"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": \"19e28f3b-c3ac-4e6a-b1f9-956d4611c18d\",\n \"walletId\": \"dd55fcc4-84a6-400b-b033-c7b2520c7963\",\n \"status\": \"PENDING\",\n \"card\": {\n \"id\": \"4f0abb73-1e64-4e53-82b4-835d0ecbd412\",\n \"cardProgramIssuingRecordId\": \"19e28f3b-c3ac-4e6a-b1f9-956d4611c18d\",\n \"cardType\": \"virtual\",\n \"label\": \"Daniel Richardson\",\n \"nameOnCard\": \"Daniel Richardson\",\n \"limitAmount\": \"110.00\",\n \"limitInterval\": \"monthly\",\n \"last4\": \"8151\",\n \"cardStatus\": \"active\",\n \"expiryMonth\": \"2\",\n \"expiryYear\": \"2029\",\n \"cardIssueType\": \"WALLET_CARD\",\n \"wallet\": {\n \"id\": \"dd55fcc4-84a6-400b-b033-c7b2520c7963\",\n \"availableBalance\": \"485.73\",\n \"currentBalance\": \"495.73\",\n \"walletName\": \"Master Wallet\"\n }\n },\n \"updatedAt\": \"2025-03-25T12:18:15.000000Z\",\n \"createdAt\": \"2025-03-25T12:18:15.000000Z\"\n }\n}"}],"_postman_id":"707f8d40-a821-4735-905d-e46b019481f0"},{"name":"List Wallet Spend Cards","id":"70f92c5c-ca96-4e15-abcb-9f488953d7e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{AUTH_TOKEN}}"},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"{{BASE_URL}}/card-program/card","description":"List all the wallet spend cards linked to your account, along with their details.
\n","urlObject":{"path":["card-program","card"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"a017dd9f-e0e6-496f-884e-b1c5d9db83d7","name":"List Wallet Credit Cards","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"{{BASE_URL}}/card-program/card"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Mon, 24 Mar 2025 08:01:36 GMT"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"phpdebugbar-id","value":"Xa2d67bf2302faf843046cbba98c50efe"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Frame-Options","value":"ALLOWALL"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"meta\": {\n \"total\": 52,\n \"perPage\": 10,\n \"currentPage\": 1,\n \"lastPage\": 6\n },\n \"data\": [\n {\n \"id\": \"19e28f3b-c3ac-4e6a-b1f9-956d4611c18d\",\n \"walletId\": \"dd55fcc4-84a6-400b-b033-c7b2520c7963\",\n \"status\": \"COMPLETED\",\n \"card\": {\n \"id\": \"4f0abb73-1e64-4e53-82b4-835d0ecbd412\",\n \"cardProgramIssuingRecordId\": \"19e28f3b-c3ac-4e6a-b1f9-956d4611c18d\",\n \"cardType\": \"virtual\",\n \"label\": \"Daniel Richardson\",\n \"nameOnCard\": \"Daniel Richardson\",\n \"limitAmount\": \"110.00\",\n \"limitInterval\": \"monthly\",\n \"last4\": \"8151\",\n \"cardStatus\": \"active\",\n \"expiryMonth\": \"2\",\n \"expiryYear\": \"2029\",\n \"cardIssueType\": \"WALLET_CARD\",\n \"wallet\": {\n \"id\": \"dd55fcc4-84a6-400b-b033-c7b2520c7963\",\n \"availableBalance\": \"485.73\",\n \"currentBalance\": \"495.73\",\n \"walletName\": \"Master Wallet\"\n }\n },\n \"updatedAt\": \"2025-03-25T12:18:19.000000Z\",\n \"createdAt\": \"2025-03-25T12:18:15.000000Z\"\n },\n {\n \"id\": \"44069e7f-c27f-48ca-818c-de66d97a8c26\",\n \"walletId\": \"dd55fcc4-84a6-400b-b033-c7b2520c7963\",\n \"status\": \"COMPLETED\",\n \"card\": {\n \"id\": \"af76976f-6d9a-465e-aca6-f140c7a6d687\",\n \"cardProgramIssuingRecordId\": \"44069e7f-c27f-48ca-818c-de66d97a8c26\",\n \"cardType\": \"virtual\",\n \"label\": \"Daniel Richardson\",\n \"nameOnCard\": \"Daniel Richardson\",\n \"limitAmount\": \"110.00\",\n \"limitInterval\": \"monthly\",\n \"last4\": \"8754\",\n \"cardStatus\": \"active\",\n \"expiryMonth\": \"2\",\n \"expiryYear\": \"2031\",\n \"cardIssueType\": \"WALLET_CARD\",\n \"wallet\": {\n \"id\": \"dd55fcc4-84a6-400b-b033-c7b2520c7963\",\n \"availableBalance\": \"485.73\",\n \"currentBalance\": \"495.73\",\n \"walletName\": \"Master Wallet\"\n }\n },\n \"updatedAt\": \"2025-03-25T04:43:24.000000Z\",\n \"createdAt\": \"2025-03-25T04:43:20.000000Z\"\n },\n {\n \"id\": \"61a7ef4a-9185-475e-a914-ba259ee7162e\",\n \"walletId\": \"dd55fcc4-84a6-400b-b033-c7b2520c7963\",\n \"status\": \"COMPLETED\",\n \"card\": {\n \"id\": \"5cac1db4-bbde-4bed-8b18-ac6d02ba6d43\",\n \"cardProgramIssuingRecordId\": \"61a7ef4a-9185-475e-a914-ba259ee7162e\",\n \"cardType\": \"virtual\",\n \"label\": \"Daniel Richardson\",\n \"nameOnCard\": \"Daniel Richardson\",\n \"limitAmount\": \"55.00\",\n \"limitInterval\": \"monthly\",\n \"last4\": \"0018\",\n \"cardStatus\": \"active\",\n \"expiryMonth\": \"2\",\n \"expiryYear\": \"2031\",\n \"cardIssueType\": \"WALLET_CARD\",\n \"wallet\": {\n \"id\": \"dd55fcc4-84a6-400b-b033-c7b2520c7963\",\n \"availableBalance\": \"485.73\",\n \"currentBalance\": \"495.73\",\n \"walletName\": \"Master Wallet\"\n }\n },\n \"updatedAt\": \"2025-03-25T04:42:06.000000Z\",\n \"createdAt\": \"2025-03-25T04:42:01.000000Z\"\n },\n {\n \"id\": \"7d6c9e87-3d2f-40d0-b637-b89d7fd78f2f\",\n \"walletId\": \"dd55fcc4-84a6-400b-b033-c7b2520c7963\",\n \"status\": \"COMPLETED\",\n \"card\": {\n \"id\": \"0fde7804-f5d4-4407-8def-f441ae312cbb\",\n \"cardProgramIssuingRecordId\": \"7d6c9e87-3d2f-40d0-b637-b89d7fd78f2f\",\n \"cardType\": \"virtual\",\n \"label\": \"Daniel Richardson\",\n \"nameOnCard\": \"Daniel Richardson\",\n \"limitAmount\": \"35.00\",\n \"limitInterval\": \"monthly\",\n \"last4\": \"6162\",\n \"cardStatus\": \"active\",\n \"expiryMonth\": \"11\",\n \"expiryYear\": \"2029\",\n \"cardIssueType\": \"WALLET_CARD\",\n \"wallet\": {\n \"id\": \"dd55fcc4-84a6-400b-b033-c7b2520c7963\",\n \"availableBalance\": \"485.73\",\n \"currentBalance\": \"495.73\",\n \"walletName\": \"Master Wallet\"\n }\n },\n \"updatedAt\": \"2025-03-24T07:58:28.000000Z\",\n \"createdAt\": \"2025-03-24T07:58:23.000000Z\"\n },\n {\n \"id\": \"142b4fcb-4fb0-462f-b63b-e71e0b9282d8\",\n \"walletId\": \"dd55fcc4-84a6-400b-b033-c7b2520c7963\",\n \"status\": \"COMPLETED\",\n \"card\": {\n \"id\": \"a6cef449-2463-4d9b-a739-7ab707342515\",\n \"cardProgramIssuingRecordId\": \"142b4fcb-4fb0-462f-b63b-e71e0b9282d8\",\n \"cardType\": \"virtual\",\n \"label\": \"Daniel Richardson\",\n \"nameOnCard\": \"Daniel Richardson\",\n \"limitAmount\": \"45.00\",\n \"limitInterval\": \"monthly\",\n \"last4\": \"7427\",\n \"cardStatus\": \"active\",\n \"expiryMonth\": \"12\",\n \"expiryYear\": \"2029\",\n \"cardIssueType\": \"WALLET_CARD\",\n \"wallet\": {\n \"id\": \"dd55fcc4-84a6-400b-b033-c7b2520c7963\",\n \"availableBalance\": \"485.73\",\n \"currentBalance\": \"495.73\",\n \"walletName\": \"Master Wallet\"\n }\n },\n \"updatedAt\": \"2025-03-24T07:00:24.000000Z\",\n \"createdAt\": \"2025-03-24T07:00:20.000000Z\"\n },\n {\n \"id\": \"cbd349c9-cb90-443e-b9f5-0624fb28ffa2\",\n \"walletId\": \"dd55fcc4-84a6-400b-b033-c7b2520c7963\",\n \"status\": \"COMPLETED\",\n \"card\": {\n \"id\": \"31d3c82b-a15c-43cf-9895-fa7620218216\",\n \"cardProgramIssuingRecordId\": \"cbd349c9-cb90-443e-b9f5-0624fb28ffa2\",\n \"cardType\": \"virtual\",\n \"label\": \"Daniel Richardson\",\n \"nameOnCard\": \"Daniel Richardson\",\n \"limitAmount\": \"45.00\",\n \"limitInterval\": \"monthly\",\n \"last4\": \"1976\",\n \"cardStatus\": \"active\",\n \"expiryMonth\": \"2\",\n \"expiryYear\": \"2029\",\n \"cardIssueType\": \"WALLET_CARD\",\n \"wallet\": {\n \"id\": \"dd55fcc4-84a6-400b-b033-c7b2520c7963\",\n \"availableBalance\": \"485.73\",\n \"currentBalance\": \"495.73\",\n \"walletName\": \"Master Wallet\"\n }\n },\n \"updatedAt\": \"2025-03-24T06:35:29.000000Z\",\n \"createdAt\": \"2025-03-24T06:35:24.000000Z\"\n },\n {\n \"id\": \"7070c60b-6e68-444d-bc94-5850ffbb4abe\",\n \"walletId\": \"dd55fcc4-84a6-400b-b033-c7b2520c7963\",\n \"status\": \"COMPLETED\",\n \"card\": {\n \"id\": \"a114911e-097b-409b-9022-ca4dce155136\",\n \"cardProgramIssuingRecordId\": \"7070c60b-6e68-444d-bc94-5850ffbb4abe\",\n \"cardType\": \"virtual\",\n \"label\": \"AJANYA\",\n \"nameOnCard\": \"ajanya tk\",\n \"limitAmount\": \"9000.00\",\n \"limitInterval\": \"monthly\",\n \"last4\": \"1620\",\n \"cardStatus\": \"active\",\n \"expiryMonth\": \"1\",\n \"expiryYear\": \"2030\",\n \"cardIssueType\": \"WALLET_CARD\",\n \"wallet\": {\n \"id\": \"dd55fcc4-84a6-400b-b033-c7b2520c7963\",\n \"availableBalance\": \"485.73\",\n \"currentBalance\": \"495.73\",\n \"walletName\": \"Master Wallet\"\n }\n },\n \"updatedAt\": \"2025-03-19T04:19:05.000000Z\",\n \"createdAt\": \"2025-03-19T04:19:00.000000Z\"\n },\n {\n \"id\": \"cc3f8458-1348-465b-a2ce-c75f07779024\",\n \"walletId\": \"0315658a-fc3c-4ceb-a7b0-bff48dcb1e22\",\n \"status\": \"COMPLETED\",\n \"card\": {\n \"id\": \"92a6e8d5-87bb-4d95-858f-ea04cee290c6\",\n \"cardProgramIssuingRecordId\": \"cc3f8458-1348-465b-a2ce-c75f07779024\",\n \"cardType\": \"physical\",\n \"label\": \"Emma Richardson\",\n \"nameOnCard\": \"Emma Richardson\",\n \"limitAmount\": \"200.00\",\n \"limitInterval\": \"allTime\",\n \"last4\": \"6197\",\n \"cardStatus\": \"active\",\n \"expiryMonth\": \"3\",\n \"expiryYear\": \"2029\",\n \"cardIssueType\": \"WALLET_CARD\",\n \"wallet\": {\n \"id\": \"0315658a-fc3c-4ceb-a7b0-bff48dcb1e22\",\n \"availableBalance\": \"345.96\",\n \"currentBalance\": \"345.96\",\n \"walletName\": \"RAIN WALLET\"\n }\n },\n \"updatedAt\": \"2025-03-18T10:23:56.000000Z\",\n \"createdAt\": \"2025-03-18T10:23:52.000000Z\"\n },\n {\n \"id\": \"76691fcf-e535-4128-a81e-25874268ec32\",\n \"walletId\": \"0315658a-fc3c-4ceb-a7b0-bff48dcb1e22\",\n \"status\": \"COMPLETED\",\n \"card\": {\n \"id\": \"b02b93f5-a399-4211-a600-feb3ce347c51\",\n \"cardProgramIssuingRecordId\": \"76691fcf-e535-4128-a81e-25874268ec32\",\n \"cardType\": \"virtual\",\n \"label\": \"Olivia Hayes\",\n \"nameOnCard\": \"Olivia Hayes\",\n \"limitAmount\": \"200.00\",\n \"limitInterval\": \"monthly\",\n \"last4\": \"4373\",\n \"cardStatus\": \"active\",\n \"expiryMonth\": \"6\",\n \"expiryYear\": \"2031\",\n \"cardIssueType\": \"WALLET_CARD\",\n \"wallet\": {\n \"id\": \"0315658a-fc3c-4ceb-a7b0-bff48dcb1e22\",\n \"availableBalance\": \"345.96\",\n \"currentBalance\": \"345.96\",\n \"walletName\": \"RAIN WALLET\"\n }\n },\n \"updatedAt\": \"2025-03-18T10:22:53.000000Z\",\n \"createdAt\": \"2025-03-18T10:22:49.000000Z\"\n },\n {\n \"id\": \"7efba893-5c87-4223-b9e8-bdfd904aa969\",\n \"walletId\": \"470a545d-650b-4a9a-9167-58d899519e11\",\n \"status\": \"COMPLETED\",\n \"card\": {\n \"id\": \"e5e6180b-6797-4bb6-b786-cf3b2ca3d459\",\n \"cardProgramIssuingRecordId\": \"7efba893-5c87-4223-b9e8-bdfd904aa969\",\n \"cardType\": \"physical\",\n \"label\": \"Sophia Reynolds\",\n \"nameOnCard\": \"Sophia Reynolds\",\n \"limitAmount\": \"120.00\",\n \"limitInterval\": \"perTransaction\",\n \"last4\": \"2625\",\n \"cardStatus\": \"active\",\n \"expiryMonth\": \"6\",\n \"expiryYear\": \"2031\",\n \"cardIssueType\": \"WALLET_CARD\",\n \"wallet\": {\n \"id\": \"470a545d-650b-4a9a-9167-58d899519e11\",\n \"availableBalance\": \"903.00\",\n \"currentBalance\": \"903.00\",\n \"walletName\": \"MY BANK 2\"\n }\n },\n \"updatedAt\": \"2025-03-18T10:11:03.000000Z\",\n \"createdAt\": \"2025-03-18T10:11:00.000000Z\"\n }\n ]\n}"}],"_postman_id":"70f92c5c-ca96-4e15-abcb-9f488953d7e6"},{"name":"Show Wallet Spend Card Details","id":"87a79068-40aa-4960-a7fa-468c4bbeb950","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{AUTH_TOKEN}}"},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"{{BASE_URL}}/card-program/card/show-card/7d6c9e87-3d2f-40d0-b637-b89d7fd78f2f","description":"This endpoint returns encrypted sensitive card information, including PAN and CVC.
\n⚠️ IMPORTANT: We don't encourage viewing or storing sensitive user card information. While we expose the last 4 digits of the card and expiry date, there are compliance requirements involved with viewing the full card number and CVC.
\nClient-Side Implementation
\nasync function decryptSecret(base64Secret, base64Iv, secretKey) {\n if (!base64Secret) throw new Error(\"base64Secret is required\");\n if (!base64Iv) throw new Error(\"base64Iv is required\");\n if (!secretKey || !/^[0-9A-Fa-f]+$/.test(secretKey)) {\n throw new Error(\"secretKey must be a hex string\");\n }\n const secret = Uint8Array.from(window.atob(base64Secret), (c) =>\n c.charCodeAt(0)\n );\n const iv = Uint8Array.from(window.atob(base64Iv), (c) => c.charCodeAt(0));\n const secretKeyArrayBuffer = Uint8Array.from(\n secretKey.match(/.{1,2}/g).map((byte) => parseInt(byte, 16))\n );\n const cryptoKey = await window.crypto.subtle.importKey(\n \"raw\",\n secretKeyArrayBuffer,\n { name: \"AES-GCM\" },\n false,\n [\"decrypt\"]\n );\n const decrypted = await window.crypto.subtle.decrypt(\n {\n name: \"AES-GCM\",\n iv: iv,\n },\n cryptoKey,\n secret\n );\n return new TextDecoder().decode(decrypted);\n}\nconst token = {\n secretKey: \"1e5c75798c126759cef12d51a3cf91d0\",\n token: {\n encryptedPan: {\n iv: \"5j5clFu1W6e2QScs+AcfcQ==\",\n data: \"0lTRFZ1P/1SSPsM0BgmgYaN7nmW74Er1L0VO97jV+eI=\",\n },\n encryptedCvc: {\n iv: \"cSD3OKIi9/j612N5vnEHgw==\",\n data: \"tPPyZfmBN96t9xsMRp7LgYz9Vw==\",\n },\n },\n};\n// Wrap the decryption code in an async function\nasync function decryptAndDisplay() {\n try {\n let pan = await decryptSecret(\n token.token.encryptedPan.data,\n token.token.encryptedPan.iv,\n token.secretKey\n );\n let cvc = await decryptSecret(\n token.token.encryptedCvc.data,\n token.token.encryptedCvc.iv,\n token.secretKey\n );\n pan = pan.match(/.{1,4}/g).join(\" \");\n document.querySelector(\".PAN\").textContent = `CARD: ${pan}`;\n document.querySelector(\".CVC\").textContent = `CVC: ${cvc}`;\n } catch (error) {\n console.error(\"Decryption error:\", error);\n }\n}\n// Call the function when the page loads\ndecryptAndDisplay();\n\nResponse Format
\nWhen successful, the decryption functions will return:
\nFor PAN: The full card number
\nFor CVC: The 3 or 4 digit security code
\nThe script then formats the card number with spaces between each group of 4 digits before displaying.
\nHTML Requirements
\nElements with classes .PAN and .CVC must exist in the DOM
Example:
\nSecurity Considerations
\nThis implementation should only be used in PCI-DSS compliant environments
\nAdhere to all security requirements when handling card data
\nMinimize storage and display of card information
\nEnsure secure transmission of decryption keys
\nError Handling
\nThe script validates required parameters
\nValidates the secret key format
\nCatches and logs decryption errors to the console
\nThis API endpoint retrieves the transaction history and details for a specific spend card linked to a wallet using the card ID.
\n","urlObject":{"path":["card-program","44069e7f-c27f-48ca-818c-de66d97a8c26","transactions"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"7dffa89d-c0d3-44a4-ac7b-5c13c54c9df3","name":"Show Wallet Credit Card Transaction Details","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"{{BASE_URL}}/card-program/44069e7f-c27f-48ca-818c-de66d97a8c26/transactions"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"meta\": {\n \"total\": 3,\n \"perPage\": 10,\n \"currentPage\": 1,\n \"lastPage\": 1\n },\n \"data\": [\n {\n \"id\": \"ebf36450-cce6-4624-a5ac-1290da6857f9\",\n \"cardProgramIssuingRecordId\": \"44069e7f-c27f-48ca-818c-de66d97a8c26\",\n \"cardId\": \"af76976f-6d9a-465e-aca6-f140c7a6d687\",\n \"amount\": \"10.00\",\n \"description\": \"Paypal \",\n \"status\": \"declined\",\n \"transactionDate\": \"2025-03-26 06:11:52\",\n \"merchantName\": \"Paypal \",\n \"merchantCity\": null,\n \"merchantState\": null,\n \"merchantCountry\": null,\n \"merchantCategoryCode\": \"\"\n },\n {\n \"id\": \"0156ca31-e5ae-4522-b84e-6a5d2934418b\",\n \"cardProgramIssuingRecordId\": \"44069e7f-c27f-48ca-818c-de66d97a8c26\",\n \"cardId\": \"af76976f-6d9a-465e-aca6-f140c7a6d687\",\n \"amount\": \"10.00\",\n \"description\": \"Amazon \",\n \"status\": \"declined\",\n \"transactionDate\": \"2025-03-26 05:20:19\",\n \"merchantName\": \"Amazon \",\n \"merchantCity\": null,\n \"merchantState\": null,\n \"merchantCountry\": null,\n \"merchantCategoryCode\": \"\"\n },\n {\n \"id\": \"fdead0da-e96d-48a2-a477-980aa3416123\",\n \"cardProgramIssuingRecordId\": \"44069e7f-c27f-48ca-818c-de66d97a8c26\",\n \"cardId\": \"af76976f-6d9a-465e-aca6-f140c7a6d687\",\n \"amount\": \"25.00\",\n \"description\": \"Spotify \",\n \"status\": \"declined\",\n \"transactionDate\": \"2025-03-26 05:19:56\",\n \"merchantName\": \"Spotify \",\n \"merchantCity\": null,\n \"merchantState\": null,\n \"merchantCountry\": null,\n \"merchantCategoryCode\": \"\"\n }\n ]\n}"},{"id":"69cb20a2-ee0e-4247-b4e6-b2683a0a151e","name":"Webhook : card-program.card.transaction.created","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text","disabled":true}],"url":""},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"event\": {\n \"type\": \"card-program.card.transaction.created\",\n \"data\": {\n \"id\": \"574ad020-44b7-49ed-b631-729dc39ae8be\",\n \"cardProgramIssuingRecordId\": \"34fc75f6-0fa9-4979-a132-0f4feb1fa8b1\",\n \"cardId\": \"5fd81974-b810-4845-9c38-1cb4a09c0bdb\",\n \"amount\": \"12.00\",\n \"description\": \"Walmart\",\n \"status\": \"pending\",\n \"transactionDate\": \"2025-03-26 09:15:33\",\n \"merchantName\": \"Walmart\",\n \"merchantCity\": null,\n \"merchantState\": null,\n \"merchantCountry\": null,\n \"merchantCategoryCode\": \"\"\n },\n \"id\": \"01cbdfe2-d53e-417b-8e2a-c9c24af8fe8e\",\n \"createdAt\": \"2025-03-26T09:15:37.000000Z\"\n }\n}"},{"id":"caad6b9a-7dd6-4d1c-b991-8019f0ef97ee","name":"Webhook : card-program.card.transaction.updated","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text","disabled":true}],"url":""},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"event\": {\n \"type\": \"card-program.card.transaction.updated\",\n \"data\": {\n \"id\": \"574ad020-44b7-49ed-b631-729dc39ae8be\",\n \"cardProgramIssuingRecordId\": \"34fc75f6-0fa9-4979-a132-0f4feb1fa8b1\",\n \"cardId\": \"5fd81974-b810-4845-9c38-1cb4a09c0bdb\",\n \"amount\": \"12.00\",\n \"description\": \"Walmart\",\n \"status\": \"completed\",\n \"transactionDate\": \"2025-03-26 09:15:33\",\n \"merchantName\": \"Walmart\",\n \"merchantCity\": null,\n \"merchantState\": null,\n \"merchantCountry\": null,\n \"merchantCategoryCode\": \"\"\n },\n \"id\": \"3931f1ed-6f3c-46ef-a635-c2abbc774351\",\n \"createdAt\": \"2025-03-26T09:15:37.000000Z\"\n }\n}"}],"_postman_id":"0ab693f1-ed26-4cce-a942-6f99ad217696"},{"name":"Update Wallet Spend Card","id":"856148c1-c8b3-4bd3-8981-b402987cc147","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{AUTH_TOKEN}}"},"isInherited":false},"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"limitAmount\": 250,\r\n \"limitInterval\": \"weekly\",\r\n \"label\": \"Eric Samuel\",\r\n \"restrictionSettings\": {\r\n \"validTill\": \"2026-01-01\",\r\n \"allowedMerchantNames\": [\r\n \"amazon\",\r\n \"flipkart\"\r\n ],\r\n \"allowedMerchantCategoryCode\": [\r\n \"700\",\r\n \"3350\",\r\n \"7852\"\r\n ],\r\n \"allowedMerchantCountry\": [\r\n \"US\",\r\n \"IN\",\r\n \"GB\"\r\n ],\r\n \"allowedMerchantCity\": [\r\n \"newyork\",\r\n \"Chicago\"\r\n ],\r\n \"allowedTime\": {\r\n \"timezone\": \"America/Chicago\",\r\n \"times\": [\r\n {\r\n \"from\": \"11:00\",\r\n \"to\": \"12:00\"\r\n },\r\n {\r\n \"from\": \"17:00\",\r\n \"to\": \"23:59\"\r\n }\r\n ]\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/card-program/card/b093ef67-c6d5-4c9a-ae84-154c7c8558a","description":"Use this endpoint to update a wallet spend card’s limit, interval, label, and restrictions, including allowed Merchant names, category codes, countries, cities, and permitted transaction times.
\nPayload Parameters
\n","urlObject":{"path":["card-program","card","b093ef67-c6d5-4c9a-ae84-154c7c8558a"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"268ee42a-b64e-4c33-9834-a37b2df0ae77","name":"Update Wallet Spend Card","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"limitAmount\": 250,\r\n \"limitInterval\": \"weekly\",\r\n \"label\": \"Eric Samuel\",\r\n \"restrictionSettings\": {\r\n \"validTill\": \"2026-01-01\",\r\n \"allowedMerchantNames\": [\r\n \"amazon\",\r\n \"flipkart\"\r\n ],\r\n \"allowedMerchantCategoryCode\": [\r\n \"700\",\r\n \"3350\",\r\n \"7852\"\r\n ],\r\n \"allowedMerchantCountry\": [\r\n \"US\",\r\n \"IN\",\r\n \"GB\"\r\n ],\r\n \"allowedMerchantCity\": [\r\n \"newyork\",\r\n \"Chicago\"\r\n ],\r\n \"allowedTime\": {\r\n \"timezone\": \"America/Chicago\",\r\n \"times\": [\r\n {\r\n \"from\": \"11:00\",\r\n \"to\": \"12:00\"\r\n },\r\n {\r\n \"from\": \"17:00\",\r\n \"to\": \"23:59\"\r\n }\r\n ]\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/card-program/card/b093ef67-c6d5-4c9a-ae84-154c7c8558a"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Mon, 24 Mar 2025 08:00:06 GMT"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"phpdebugbar-id","value":"X6df551b9f5cb33016d530a016a1e71a1"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Frame-Options","value":"ALLOWALL"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": \"2ad46340-88f2-4c9a-809b-55304f98da43\",\n \"cardProgramIssuingRecordId\": \"\",\n \"cardType\": \"virtual\",\n \"label\": \"Eric Samuel\",\n \"nameOnCard\": \"Eric Abidal\",\n \"limitAmount\": \"250.00\",\n \"limitInterval\": \"weekly\",\n \"last4\": \"8309\",\n \"cardStatus\": \"active\",\n \"expiryMonth\": \"11\",\n \"expiryYear\": \"2030\",\n \"restrictionSettings\": {\n \"validTill\": \"2026-01-01\",\n \"allowedMerchantNames\": [\n \"amazon\",\n \"flipkart\"\n ],\n \"allowedMerchantCategoryCode\": [\n \"700\",\n \"3350\",\n \"7852\"\n ],\n \"allowedMerchantCountry\": [\n \"US\",\n \"IN\",\n \"GB\"\n ],\n \"allowedMerchantCity\": [\n \"newyork\",\n \"Chicago\"\n ],\n \"allowedTime\": {\n \"timezone\": \"America/Chicago\",\n \"times\": [\n {\n \"from\": \"11:00\",\n \"to\": \"12:00\"\n },\n {\n \"from\": \"17:00\",\n \"to\": \"23:59\"\n }\n ]\n }\n }\n }\n}"}],"_postman_id":"856148c1-c8b3-4bd3-8981-b402987cc147"},{"name":"Update Wallet Spend Card Status","id":"c3a2b454-32da-41c2-b81e-069d1028a2ae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{AUTH_TOKEN}}"},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"status\": \"active\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/card-program/card/2ad46340-88f2-4c9a-809b-55304f98da43/change-status","description":"Use this endpoint to update the status of a wallet spend card.
\nThis API endpoint allows you to create a gift card linked to a specified wallet, with customizable spending limits. Choose between onetime or rechargeable cards and assign it to a payee.
\nPayload Parameters
\n","urlObject":{"path":["card-program","gift-card","create"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"0b869af6-9a42-4193-badf-5e5625fedace","name":"Create Wallet Gift Card","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"walletId\": \"dd55fcc4-84a6-400b-b033-c7b2520c7963\",\r\n \"limitAmount\": 75,\r\n \"cardType\": \"virtual\",\r\n \"cardLimitType\": \"rechargeable\",\r\n \"payeeId\": \"QaMdjZLBb7GzLxb\",\r\n \"payeeEmail\": \"daniel.anderson@email.com\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/card-program/gift-card/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Mon, 24 Mar 2025 08:11:59 GMT"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"phpdebugbar-id","value":"Xcefc814c2d7a0fe7cc4d3cef2bc015c0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Frame-Options","value":"ALLOWALL"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": \"ad51a361-cb91-4d69-a2d6-66a62867f232\",\n \"walletId\": \"dd55fcc4-84a6-400b-b033-c7b2520c7963\",\n \"status\": \"COMPLETED\",\n \"card\": {\n \"id\": \"d009d218-c5f1-4fac-8d08-facb47766582\",\n \"cardProgramIssuingRecordId\": \"ad51a361-cb91-4d69-a2d6-66a62867f232\",\n \"cardType\": \"virtual\",\n \"label\": \"Ethan Harris\",\n \"nameOnCard\": \"Ethan Harris\",\n \"limitAmount\": \"75.00\",\n \"limitInterval\": \"allTime\",\n \"last4\": \"6204\",\n \"cardStatus\": \"pending_activation\",\n \"expiryMonth\": \"11\",\n \"expiryYear\": \"2031\",\n \"holder\": {\n \"payeeId\": \"dNDOGnBn2oG0oMX\",\n \"name\": \"Ethan Harris\",\n \"email\": \"ethan.harris@email.com\",\n \"address1\": \"1111 Franklin Avenue\",\n \"address2\": null,\n \"city\": \"Valley Stream\",\n \"state\": \"NY\",\n \"country\": \"US\",\n \"zip\": \"11580\"\n },\n \"cardIssueType\": \"RECHARGEABLE_GIFT_CARD\"\n },\n \"availableBalance\": \"75.00\",\n \"updatedAt\": \"2025-03-20T04:55:28.000000Z\",\n \"createdAt\": \"2025-03-20T04:55:23.000000Z\"\n }\n}"}],"_postman_id":"4f20863a-0407-46ca-8961-d9c27862f3cc"},{"name":"Retrieve Wallet Gift Card","id":"903ec561-787d-4cb3-b8cb-3c0c843926a9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{AUTH_TOKEN}}"},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/card-program/gift-card/ad51a361-cb91-4d69-a2d6-66a62867f232","description":"Retrieves the details of a specific gift card using its unique ID.
\n","urlObject":{"path":["card-program","gift-card","ad51a361-cb91-4d69-a2d6-66a62867f232"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"65404cab-e957-4d84-9f23-147ca14bbb1c","name":"Retrieve Wallet Gift Card","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"{{BASE_URL}}/card-program/gift-card/ad51a361-cb91-4d69-a2d6-66a62867f232"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Mon, 24 Mar 2025 08:13:21 GMT"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"phpdebugbar-id","value":"X2977dc7476404842eee9f0475f883a51"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Frame-Options","value":"ALLOWALL"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": \"ad51a361-cb91-4d69-a2d6-66a62867f232\",\n \"walletId\": \"dd55fcc4-84a6-400b-b033-c7b2520c7963\",\n \"status\": \"COMPLETED\",\n \"card\": {\n \"id\": \"d009d218-c5f1-4fac-8d08-facb47766582\",\n \"cardProgramIssuingRecordId\": \"ad51a361-cb91-4d69-a2d6-66a62867f232\",\n \"cardType\": \"virtual\",\n \"label\": \"Ethan Harris\",\n \"nameOnCard\": \"Ethan Harris\",\n \"limitAmount\": \"75.00\",\n \"limitInterval\": \"allTime\",\n \"last4\": \"6204\",\n \"cardStatus\": \"pending_activation\",\n \"expiryMonth\": \"11\",\n \"expiryYear\": \"2031\",\n \"holder\": {\n \"payeeId\": \"dNDOGnBn2oG0oMX\",\n \"name\": \"Ethan Harris\",\n \"email\": \"ethan.harris@email.com\",\n \"address1\": \"1111 Franklin Avenue\",\n \"address2\": null,\n \"city\": \"Valley Stream\",\n \"state\": \"NY\",\n \"country\": \"US\",\n \"zip\": \"11580\"\n },\n \"cardIssueType\": \"RECHARGEABLE_GIFT_CARD\"\n },\n \"availableBalance\": \"75.00\",\n \"updatedAt\": \"2025-03-20T04:55:28.000000Z\",\n \"createdAt\": \"2025-03-20T04:55:23.000000Z\"\n }\n}"}],"_postman_id":"903ec561-787d-4cb3-b8cb-3c0c843926a9"},{"name":"List Wallet Gift Cards","id":"293ed5f2-988d-476c-ad3c-2b568f3f5b4e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{AUTH_TOKEN}}"},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/card-program/gift-card","description":"List all the wallet gift cards linked to your account, along with their details.
\n","urlObject":{"path":["card-program","gift-card"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"d8812887-8f55-4d96-8fca-fcf021d38971","name":"List Wallet Gift Cards","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"{{BASE_URL}}/card-program/gift-card"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Mon, 24 Mar 2025 08:14:23 GMT"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"phpdebugbar-id","value":"X06c14291a1d4b659ea384c66e3dbf802"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Frame-Options","value":"ALLOWALL"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"meta\": {\n \"total\": 84,\n \"perPage\": 10,\n \"currentPage\": 1,\n \"lastPage\": 9\n },\n \"data\": [\n {\n \"id\": \"95e8ed87-d31e-4147-bdf1-a3a6fffd53af\",\n \"walletId\": \"dd55fcc4-84a6-400b-b033-c7b2520c7963\",\n \"status\": \"COMPLETED\",\n \"card\": {\n \"id\": \"7e6518a6-c01f-407f-a5a1-0515e381362e\",\n \"cardProgramIssuingRecordId\": \"95e8ed87-d31e-4147-bdf1-a3a6fffd53af\",\n \"cardType\": \"virtual\",\n \"label\": \"Daniel Anderson\",\n \"nameOnCard\": \"Daniel Anderson\",\n \"limitAmount\": \"10.00\",\n \"limitInterval\": \"allTime\",\n \"last4\": \"9391\",\n \"cardStatus\": \"pending_activation\",\n \"expiryMonth\": \"9\",\n \"expiryYear\": \"2031\",\n \"holder\": {\n \"payeeId\": \"QaMdjZLBb7GzLxb\",\n \"name\": \"Daniel Anderson\",\n \"email\": \"daniel.anderson@email.com\",\n \"address1\": null,\n \"address2\": null,\n \"city\": null,\n \"state\": null,\n \"country\": null,\n \"zip\": null\n },\n \"cardIssueType\": \"RECHARGEABLE_GIFT_CARD\"\n },\n \"availableBalance\": \"10.00\",\n \"updatedAt\": \"2025-03-25T12:10:09.000000Z\",\n \"createdAt\": \"2025-03-25T12:10:05.000000Z\"\n },\n {\n \"id\": \"c949fdd9-b6e7-4200-a22a-d0b8e09a5189\",\n \"walletId\": \"dd55fcc4-84a6-400b-b033-c7b2520c7963\",\n \"status\": \"COMPLETED\",\n \"card\": {\n \"id\": \"a0eee8dc-b9e3-45ad-a25d-5e8776e24e9b\",\n \"cardProgramIssuingRecordId\": \"c949fdd9-b6e7-4200-a22a-d0b8e09a5189\",\n \"cardType\": \"virtual\",\n \"label\": \"Daniel Anderson\",\n \"nameOnCard\": \"Daniel Anderson\",\n \"limitAmount\": \"5.00\",\n \"limitInterval\": \"allTime\",\n \"last4\": \"0611\",\n \"cardStatus\": \"pending_activation\",\n \"expiryMonth\": \"8\",\n \"expiryYear\": \"2030\",\n \"holder\": {\n \"payeeId\": \"QaMdjZLBb7GzLxb\",\n \"name\": \"Daniel Anderson\",\n \"email\": \"daniel.anderson@email.com\",\n \"address1\": null,\n \"address2\": null,\n \"city\": null,\n \"state\": null,\n \"country\": null,\n \"zip\": null\n },\n \"cardIssueType\": \"RECHARGEABLE_GIFT_CARD\"\n },\n \"availableBalance\": \"5.00\",\n \"updatedAt\": \"2025-03-25T11:58:29.000000Z\",\n \"createdAt\": \"2025-03-25T11:58:24.000000Z\"\n },\n {\n \"id\": \"f2a27295-4baa-464d-a85b-318be393f5e5\",\n \"walletId\": \"dd55fcc4-84a6-400b-b033-c7b2520c7963\",\n \"status\": \"COMPLETED\",\n \"card\": {\n \"id\": \"136726b8-2a1b-4465-909c-259f332f6393\",\n \"cardProgramIssuingRecordId\": \"f2a27295-4baa-464d-a85b-318be393f5e5\",\n \"cardType\": \"virtual\",\n \"label\": \"Daniel Anderson\",\n \"nameOnCard\": \"Daniel Anderson\",\n \"limitAmount\": \"5.00\",\n \"limitInterval\": \"allTime\",\n \"last4\": \"6874\",\n \"cardStatus\": \"pending_activation\",\n \"expiryMonth\": \"8\",\n \"expiryYear\": \"2029\",\n \"holder\": {\n \"payeeId\": \"QaMdjZLBb7GzLxb\",\n \"name\": \"Daniel Anderson\",\n \"email\": \"daniel.anderson@email.com\",\n \"address1\": null,\n \"address2\": null,\n \"city\": null,\n \"state\": null,\n \"country\": null,\n \"zip\": null\n },\n \"cardIssueType\": \"RECHARGEABLE_GIFT_CARD\"\n },\n \"availableBalance\": \"5.00\",\n \"updatedAt\": \"2025-03-25T05:00:57.000000Z\",\n \"createdAt\": \"2025-03-25T05:00:52.000000Z\"\n },\n {\n \"id\": \"8535b6c1-6a41-432e-9da0-c7fb94d658f7\",\n \"walletId\": \"dd55fcc4-84a6-400b-b033-c7b2520c7963\",\n \"status\": \"COMPLETED\",\n \"card\": {\n \"id\": \"aa3e5c80-4149-488a-b246-6b769fb50219\",\n \"cardProgramIssuingRecordId\": \"8535b6c1-6a41-432e-9da0-c7fb94d658f7\",\n \"cardType\": \"virtual\",\n \"label\": \"Daniel Anderson\",\n \"nameOnCard\": \"Daniel Anderson\",\n \"limitAmount\": \"75.00\",\n \"limitInterval\": \"allTime\",\n \"last4\": \"6691\",\n \"cardStatus\": \"pending_activation\",\n \"expiryMonth\": \"5\",\n \"expiryYear\": \"2031\",\n \"holder\": {\n \"payeeId\": \"QaMdjZLBb7GzLxb\",\n \"name\": \"Daniel Anderson\",\n \"email\": \"daniel.anderson@email.com\",\n \"address1\": null,\n \"address2\": null,\n \"city\": null,\n \"state\": null,\n \"country\": null,\n \"zip\": null\n },\n \"cardIssueType\": \"RECHARGEABLE_GIFT_CARD\"\n },\n \"availableBalance\": \"75.00\",\n \"updatedAt\": \"2025-03-24T08:11:59.000000Z\",\n \"createdAt\": \"2025-03-24T08:11:54.000000Z\"\n },\n {\n \"id\": \"1b9f75f5-58e6-4275-9ba2-c49d58950e86\",\n \"walletId\": \"0315658a-fc3c-4ceb-a7b0-bff48dcb1e22\",\n \"status\": \"COMPLETED\",\n \"card\": {\n \"id\": \"857ed334-ce51-44fe-808d-469d743391f0\",\n \"cardProgramIssuingRecordId\": \"1b9f75f5-58e6-4275-9ba2-c49d58950e86\",\n \"cardType\": \"virtual\",\n \"label\": \"Alison Gambala k\",\n \"nameOnCard\": \"Alison Gambala k\",\n \"limitAmount\": \"10.00\",\n \"limitInterval\": \"allTime\",\n \"last4\": \"8938\",\n \"cardStatus\": \"pending_activation\",\n \"expiryMonth\": \"11\",\n \"expiryYear\": \"2031\",\n \"holder\": {\n \"payeeId\": \"6VoW418D3oj589l\",\n \"name\": \"Alison Gambala k\",\n \"email\": \"email@test.com\",\n \"address1\": \"111 Broadway\",\n \"address2\": null,\n \"city\": \"Paterson\",\n \"state\": \"NJ\",\n \"country\": \"US\",\n \"zip\": \"07505\"\n },\n \"cardIssueType\": \"RECHARGEABLE_GIFT_CARD\"\n },\n \"availableBalance\": \"10.00\",\n \"updatedAt\": \"2025-03-22T04:46:35.000000Z\",\n \"createdAt\": \"2025-03-22T04:46:22.000000Z\"\n },\n {\n \"id\": \"0668d415-ff95-45ca-af34-344ffd2e7d50\",\n \"walletId\": \"0315658a-fc3c-4ceb-a7b0-bff48dcb1e22\",\n \"status\": \"COMPLETED\",\n \"card\": {\n \"id\": \"d184f62b-26ca-4304-8439-5dda5594e9b0\",\n \"cardProgramIssuingRecordId\": \"0668d415-ff95-45ca-af34-344ffd2e7d50\",\n \"cardType\": \"virtual\",\n \"label\": \"Johnathan Reed\",\n \"nameOnCard\": \"Johnathan Reed\",\n \"limitAmount\": \"10.00\",\n \"limitInterval\": \"allTime\",\n \"last4\": \"6255\",\n \"cardStatus\": \"pending_activation\",\n \"expiryMonth\": \"9\",\n \"expiryYear\": \"2029\",\n \"holder\": {\n \"payeeId\": \"v1byeVgN2djOQgr\",\n \"name\": \"Johnathan Reed\",\n \"email\": \"john.reed@example.com\",\n \"address1\": null,\n \"address2\": \"\",\n \"city\": null,\n \"state\": null,\n \"country\": null,\n \"zip\": null\n },\n \"cardIssueType\": \"RECHARGEABLE_GIFT_CARD\"\n },\n \"availableBalance\": \"10.00\",\n \"updatedAt\": \"2025-03-21T09:46:19.000000Z\",\n \"createdAt\": \"2025-03-21T09:46:14.000000Z\"\n },\n {\n \"id\": \"ea1756a9-0f8a-4841-af77-96a4ec06b788\",\n \"walletId\": \"0315658a-fc3c-4ceb-a7b0-bff48dcb1e22\",\n \"status\": \"COMPLETED\",\n \"card\": {\n \"id\": \"fef420b7-e045-4693-8d72-9ee5f773162b\",\n \"cardProgramIssuingRecordId\": \"ea1756a9-0f8a-4841-af77-96a4ec06b788\",\n \"cardType\": \"virtual\",\n \"label\": \"Johnathan Reed\",\n \"nameOnCard\": \"Johnathan Reed\",\n \"limitAmount\": \"22.55\",\n \"limitInterval\": \"allTime\",\n \"last4\": \"4035\",\n \"cardStatus\": \"pending_activation\",\n \"expiryMonth\": \"8\",\n \"expiryYear\": \"2030\",\n \"holder\": {\n \"payeeId\": \"v1byeVgN2djOQgr\",\n \"name\": \"Johnathan Reed\",\n \"email\": \"john.reed@example.com\",\n \"address1\": null,\n \"address2\": \"\",\n \"city\": null,\n \"state\": null,\n \"country\": null,\n \"zip\": null\n },\n \"cardIssueType\": \"RECHARGEABLE_GIFT_CARD\"\n },\n \"availableBalance\": \"22.55\",\n \"updatedAt\": \"2025-03-21T09:44:25.000000Z\",\n \"createdAt\": \"2025-03-21T09:44:16.000000Z\"\n },\n {\n \"id\": \"ad51a361-cb91-4d69-a2d6-66a62867f232\",\n \"walletId\": \"dd55fcc4-84a6-400b-b033-c7b2520c7963\",\n \"status\": \"COMPLETED\",\n \"card\": {\n \"id\": \"d009d218-c5f1-4fac-8d08-facb47766582\",\n \"cardProgramIssuingRecordId\": \"ad51a361-cb91-4d69-a2d6-66a62867f232\",\n \"cardType\": \"virtual\",\n \"label\": \"Ethan Harris\",\n \"nameOnCard\": \"Ethan Harris\",\n \"limitAmount\": \"75.00\",\n \"limitInterval\": \"allTime\",\n \"last4\": \"6204\",\n \"cardStatus\": \"pending_activation\",\n \"expiryMonth\": \"11\",\n \"expiryYear\": \"2031\",\n \"holder\": {\n \"payeeId\": \"dNDOGnBn2oG0oMX\",\n \"name\": \"Ethan Harris\",\n \"email\": \"ethan.harris@email.com\",\n \"address1\": \"1111 Franklin Avenue\",\n \"address2\": null,\n \"city\": \"Valley Stream\",\n \"state\": \"NY\",\n \"country\": \"US\",\n \"zip\": \"11580\"\n },\n \"cardIssueType\": \"RECHARGEABLE_GIFT_CARD\"\n },\n \"availableBalance\": \"75.00\",\n \"updatedAt\": \"2025-03-20T04:55:28.000000Z\",\n \"createdAt\": \"2025-03-20T04:55:23.000000Z\"\n },\n {\n \"id\": \"0309f6d7-d2f8-4a8d-9a0a-e342edea8a3b\",\n \"walletId\": \"0315658a-fc3c-4ceb-a7b0-bff48dcb1e22\",\n \"status\": \"COMPLETED\",\n \"card\": {\n \"id\": \"0a3e9242-646f-4863-ac89-3db5935a2144\",\n \"cardProgramIssuingRecordId\": \"0309f6d7-d2f8-4a8d-9a0a-e342edea8a3b\",\n \"cardType\": \"virtual\",\n \"label\": \"Ethan Harris\",\n \"nameOnCard\": \"Ethan Harris\",\n \"limitAmount\": \"49.99\",\n \"limitInterval\": \"allTime\",\n \"last4\": \"8484\",\n \"cardStatus\": \"pending_activation\",\n \"expiryMonth\": \"7\",\n \"expiryYear\": \"2031\",\n \"holder\": {\n \"payeeId\": \"dNDOGnBn2oG0oMX\",\n \"name\": \"Ethan Harris\",\n \"email\": \"ethan.harris@email.com\",\n \"address1\": null,\n \"address2\": null,\n \"city\": null,\n \"state\": null,\n \"country\": null,\n \"zip\": null\n },\n \"cardIssueType\": \"RECHARGEABLE_GIFT_CARD\"\n },\n \"availableBalance\": \"49.99\",\n \"updatedAt\": \"2025-03-19T12:39:31.000000Z\",\n \"createdAt\": \"2025-03-19T12:39:23.000000Z\"\n },\n {\n \"id\": \"f5f54e2f-c3b9-44c1-8e0a-f07834a28cc9\",\n \"walletId\": \"0315658a-fc3c-4ceb-a7b0-bff48dcb1e22\",\n \"status\": \"COMPLETED\",\n \"card\": {\n \"id\": \"24831ddf-ae94-4452-8270-0465908c2774\",\n \"cardProgramIssuingRecordId\": \"f5f54e2f-c3b9-44c1-8e0a-f07834a28cc9\",\n \"cardType\": \"virtual\",\n \"label\": \"Ava Lopez\",\n \"nameOnCard\": \"Ava Lopez\",\n \"limitAmount\": \"15.25\",\n \"limitInterval\": \"allTime\",\n \"last4\": \"1544\",\n \"cardStatus\": \"pending_activation\",\n \"expiryMonth\": \"10\",\n \"expiryYear\": \"2030\",\n \"holder\": {\n \"payeeId\": \"kWx8ePyqd5jK2Xz\",\n \"name\": \"Ava Lopez\",\n \"email\": \"ava.lopez@email.com\",\n \"address1\": null,\n \"address2\": null,\n \"city\": null,\n \"state\": null,\n \"country\": null,\n \"zip\": null\n },\n \"cardIssueType\": \"RECHARGEABLE_GIFT_CARD\"\n },\n \"availableBalance\": \"15.25\",\n \"updatedAt\": \"2025-03-19T12:39:23.000000Z\",\n \"createdAt\": \"2025-03-19T12:39:15.000000Z\"\n }\n ]\n}"}],"_postman_id":"293ed5f2-988d-476c-ad3c-2b568f3f5b4e"},{"name":"Recharge a Wallet Gift Card","id":"e142764c-eca8-4b1b-9796-909ca82c3545","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{AUTH_TOKEN}}"},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"id\": \"ad51a361-cb91-4d69-a2d6-66a62867f232\",\r\n \"amount\": 10\r\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/card-program/gift-card/add-fund","description":"Add funds to an existing gift card using its unique ID. Specify the amount to recharge the card balance.
\nPayload Parameters
\n","urlObject":{"path":["card-program","gift-card","add-fund"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"3f5a51bb-f057-40e6-9fc7-5cdd0c9ccb95","name":"Recharge a Wallet Gift Card","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"id\": \"ad51a361-cb91-4d69-a2d6-66a62867f232\",\r\n \"amount\": 10\r\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/card-program/gift-card/add-fund"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Mon, 24 Mar 2025 08:15:00 GMT"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"58"},{"key":"phpdebugbar-id","value":"Xbd1455e19930581a53f38d0cddd95844"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Frame-Options","value":"ALLOWALL"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Success\"\n}"}],"_postman_id":"e142764c-eca8-4b1b-9796-909ca82c3545"},{"name":"Show Wallet Gift Card Transaction Details","id":"57565f8d-44a1-4f48-8791-3348fe923a29","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{AUTH_TOKEN}}"},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"{{BASE_URL}}/card-program/e624997b-83d7-48a1-8f57-8787e8de61ff/transactions","description":"This API endpoint retrieves the transaction history and details for a specific gift card linked to a wallet using the card ID.
\n","urlObject":{"path":["card-program","e624997b-83d7-48a1-8f57-8787e8de61ff","transactions"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"b00b25c0-32a3-4933-8ce3-6143e16a2b19","name":"Show Wallet Gift Card Transaction Details","originalRequest":{"method":"GET","header":[],"url":"{{BASE_URL}}/card-program/e624997b-83d7-48a1-8f57-8787e8de61ff/transactions"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"meta\": {\n \"total\": 1,\n \"perPage\": 10,\n \"currentPage\": 1,\n \"lastPage\": 1\n },\n \"data\": [\n {\n \"id\": \"91b8f94c-ad88-4b00-ab74-3364727be61b\",\n \"cardProgramIssuingRecordId\": \"e624997b-83d7-48a1-8f57-8787e8de61ff\",\n \"cardId\": \"dd1123c4-3160-4e88-8dca-13ea58b9e675\",\n \"amount\": \"50.00\",\n \"description\": \"Amazone \",\n \"status\": \"declined\",\n \"transactionDate\": \"2025-03-26 10:43:51\",\n \"merchantName\": \"Amazone \",\n \"merchantCity\": null,\n \"merchantState\": null,\n \"merchantCountry\": null,\n \"merchantCategoryCode\": \"\"\n }\n ]\n}"}],"_postman_id":"57565f8d-44a1-4f48-8791-3348fe923a29"}],"id":"4a79ca4e-b20e-453c-a21b-7c63eeabc9b4","_postman_id":"4a79ca4e-b20e-453c-a21b-7c63eeabc9b4","description":""}],"id":"238bfb97-df6a-42ad-bb2f-a63171a9a44e","description":"The API allows you to create, retrieve, list, and manage both spend and gift cards. It supports issuing new cards, viewing card details, and recharging gift cards.
\n","_postman_id":"238bfb97-df6a-42ad-bb2f-a63171a9a44e"},{"name":"Check","item":[{"name":"Attachments","item":[{"name":"Add new attachment","id":"0b6abeb2-bd35-4ece-8d34-3c1dd2a4774d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{AUTH_TOKEN}}"},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{AUTH_TOKEN}} ","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"attachment","value":"","description":"File
\n","type":"text"}]},"url":"{{BASE_URL}}/checks/{checkId}/attachments","description":"Add new attachment to existing check
\nPath parameters
\n| checkId | \nRequired \n The id of the check. \n |
Payload parameters
\n| attachment | \nRequired \n File\n File of type pdf,xls,xlsx,rtf,doc and docx \n | \n
Retrieve all attachments of a existing check.
\nPath parameters
\n| checkId | \nRequired \n The id of the check. \n |
Remove attachment.
\nPath parameters
\n| checkId | \nRequired \n The id of the check. \n |
| checkAttachmentId | \nRequired \n The id of the check attachment. \n |
Retrieve details of existing attachment.
\nPath parameters
\n| checkId | \nRequired \n The id of the check. \n |
| checkAttachmentId | \nRequired \n The id of the check attachment. \n |
List all check records
\nQuery parameters
\nperPage | Number of records that you want to receive in the response,By default 10 records will be |
page | For navigating through pages ,By default first page will be listed |
term | Filter records by using any keywords |
status | Filter records by using check status ,Eg: |
referenceId | Filter records by referenceId |
column | The column name to be used for filtering records. Supported columns include payee_name,payee_nick_name,serial_number,amount,bank_account_account_name,bank_account_nick_name,memo,note |
SearchType | Defines how the search is applied to the chosen column. Eg- exact or like |
Number of records that you want to receive in the response,By default 10 records will be listed
\n","type":"text/plain"},"key":"perPage","value":""},{"description":{"content":"By default first page will be listed
\n","type":"text/plain"},"key":"page","value":""},{"description":{"content":"Filter record by using check status
\n","type":"text/plain"},"key":"status","value":""},{"description":{"content":"Filter records by using any keywords
\n","type":"text/plain"},"key":"term","value":""},{"key":"referenceId","value":""}],"variable":[]}},"response":[{"id":"a2e0272a-ae58-4917-a5f9-7ef8073c4ba2","name":"Retrieve all checks","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{AUTH_TOKEN}} "},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{BASE_URL}}/checks?perPage=&page&status&term&referenceID","host":["{{BASE_URL}}"],"path":["checks"],"query":[{"key":"perPage","value":"","description":"Number of records that you want to receive in the response,By default 10 records will be listed"},{"key":"page","value":null,"description":"By default first page will be listed"},{"key":"status","value":null,"description":"Filter record by using check status "},{"key":"term","value":null,"description":"Filter records by using any keywords"},{"key":"referenceID","value":null}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8000"},{"key":"Date","value":"Thu, 19 Nov 2020 02:57:00 GMT"},{"key":"Date","value":"Thu, 19 Nov 2020 02:57:00 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.3.11"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"57"},{"key":"phpdebugbar-id","value":"X5c67a3a750f1fb34220e51eb1cb64fc5"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"meta\": {\n \"total\": 10,\n \"currentPage\": 1,\n \"perPage\": 10\n },\n \"checks\": [\n {\n \"checkId\": \"9MqkGWW2gPGD7Ry\",\n \"serialNumber\": \"1002\",\n \"amount\": \"200.00\",\n \"amountInWord\": \" two hundred \",\n \"date\": \"10/25/20\",\n \"status\": 1,\n \"memo\": \"First, Test check using API...\",\n \"accountNumber\": \"458757\",\n \"invoiceNumber\": \"2546\",\n \"referenceId\": null,\n \"bankAccount\": {\n \"bankAccountId\": \"yd6LeMYmdQeE8Dx\",\n \"name\": \"Demo Bank Account 1\"\n },\n \"payee\": {\n \"payeeId\": \"Xw2lx48MdGMzWyD\",\n \"name\": \"Alison\"\n },\n \"category\": {\n \"categoryId\": \"MLbz3Aj3ReVw6Ev\",\n \"name\": null\n },\n \"checkStatus\": {\n \"status\": 1,\n \"description\": \"Printed\"\n },\n \"checkStatements\": [\n {\n \"status\": \"Printed\",\n \"date\": \"11/18/2020\",\n \"time\": \"06:03 am\"\n },\n {\n \"status\": \"created\",\n \"date\": \"10/15/2020\",\n \"time\": \"05:53 am\"\n }\n ]\n },\n {\n \"checkId\": \"yd6LeMEkVYeE8Dx\",\n \"serialNumber\": \"1001\",\n \"amount\": \"100.00\",\n \"amountInWord\": \" one hundred \",\n \"date\": \"10/25/20\",\n \"status\": 0,\n \"memo\": \"First, Test check using API\",\n \"accountNumber\": \"458756\",\n \"invoiceNumber\": \"2545\",\n \"referenceId\": null,\n \"bankAccount\": {\n \"bankAccountId\": \"yd6LeMYmdQeE8Dx\",\n \"name\": \"Demo Bank Account 1\"\n },\n \"payee\": {\n \"payeeId\": \"Xw2lx48MdGMzWyD\",\n \"name\": \"Alison\"\n },\n \"category\": {\n \"categoryId\": \"MLbz3Aj3ReVw6Ev\",\n \"name\": null\n },\n \"checkStatus\": {\n \"status\": 0,\n \"description\": \"New\"\n },\n \"checkStatements\": [\n {\n \"status\": \"created\",\n \"date\": \"10/15/2020\",\n \"time\": \"05:53 am\"\n }\n ]\n },\n {\n \"checkId\": \"Jy7VeB0lv74zn1m\",\n \"serialNumber\": \"1002\",\n \"amount\": \"200.00\",\n \"amountInWord\": \" two hundred \",\n \"date\": \"10/25/20\",\n \"status\": 0,\n \"memo\": \"First, Test check using API...\",\n \"accountNumber\": \"458757\",\n \"invoiceNumber\": \"2546\",\n \"referenceId\": null,\n \"bankAccount\": {\n \"bankAccountId\": \"yd6LeMYmdQeE8Dx\",\n \"name\": \"Demo Bank Account 1\"\n },\n \"payee\": {\n \"payeeId\": \"Xw2lx48MdGMzWyD\",\n \"name\": \"Alison\"\n },\n \"category\": {\n \"categoryId\": \"MLbz3Aj3ReVw6Ev\",\n \"name\": null\n },\n \"checkStatus\": {\n \"status\": 0,\n \"description\": \"New\"\n },\n \"checkStatements\": [\n {\n \"status\": \"created\",\n \"date\": \"10/15/2020\",\n \"time\": \"05:52 am\"\n }\n ]\n },\n {\n \"checkId\": \"BQPA4mPYE2j7gxq\",\n \"serialNumber\": \"1001\",\n \"amount\": \"100.00\",\n \"amountInWord\": \" one hundred \",\n \"date\": \"10/25/20\",\n \"status\": 0,\n \"memo\": \"First, Test check using API\",\n \"accountNumber\": \"458756\",\n \"invoiceNumber\": \"2545\",\n \"referenceId\": null,\n \"bankAccount\": {\n \"bankAccountId\": \"yd6LeMYmdQeE8Dx\",\n \"name\": \"Demo Bank Account 1\"\n },\n \"payee\": {\n \"payeeId\": \"Xw2lx48MdGMzWyD\",\n \"name\": \"Alison\"\n },\n \"category\": {\n \"categoryId\": \"MLbz3Aj3ReVw6Ev\",\n \"name\": null\n },\n \"checkStatus\": {\n \"status\": 0,\n \"description\": \"New\"\n },\n \"checkStatements\": [\n {\n \"status\": \"created\",\n \"date\": \"10/15/2020\",\n \"time\": \"05:52 am\"\n }\n ]\n },\n {\n \"checkId\": \"v1byeVnlwEeOQgr\",\n \"serialNumber\": \"1006\",\n \"amount\": \"120.00\",\n \"amountInWord\": \" one hundred twenty \",\n \"date\": \"10/25/20\",\n \"status\": 0,\n \"memo\": \"First, Test check using API\",\n \"accountNumber\": \"458756\",\n \"invoiceNumber\": \"2545\",\n\t\t\t\t\t\t\t\t\"referenceId\": null,\n \"bankAccount\": {\n \"bankAccountId\": \"yd6LeMYmdQeE8Dx\",\n \"name\": \"Demo Bank Account 1\"\n },\n \"payee\": {\n \"payeeId\": \"Xw2lx48MdGMzWyD\",\n \"name\": \"Alison\"\n },\n \"category\": {\n \"categoryId\": \"MLbz3Aj3ReVw6Ev\",\n \"name\": null\n },\n \"checkStatus\": {\n \"status\": 0,\n \"description\": \"New\"\n },\n \"checkStatements\": [\n {\n \"status\": \"updated\",\n \"date\": \"10/15/2020\",\n \"time\": \"05:48 am\"\n },\n {\n \"status\": \"created\",\n \"date\": \"09/17/2020\",\n \"time\": \"07:58 am\"\n }\n ]\n },\n {\n \"checkId\": \"6VoW41y7Oo4589l\",\n \"serialNumber\": \"1001\",\n \"amount\": \"100.00\",\n \"amountInWord\": \" one hundred \",\n \"date\": \"10/25/20\",\n \"status\": 0,\n \"memo\": \"First, Test check using API\",\n \"accountNumber\": \"458756\",\n \"invoiceNumber\": \"2545\",\n\t\t\t\t\t\t\t\t\"referenceId\": null,\n \"bankAccount\": {\n \"bankAccountId\": \"yd6LeMYmdQeE8Dx\",\n \"name\": \"Demo Bank Account 1\"\n },\n \"payee\": {\n \"payeeId\": \"Xw2lx48MdGMzWyD\",\n \"name\": \"Alison\"\n },\n \"category\": {\n \"categoryId\": \"OJapb4kd9GY1Ewm\",\n \"name\": \"Category 1\"\n },\n \"checkStatus\": {\n \"status\": 0,\n \"description\": \"New\"\n },\n \"checkStatements\": [\n {\n \"status\": \"created\",\n \"date\": \"09/17/2020\",\n \"time\": \"07:58 am\"\n }\n ]\n },\n {\n \"checkId\": \"5NrWjy8Yl3e2n3l\",\n \"serialNumber\": \"1002\",\n \"amount\": \"200.00\",\n \"amountInWord\": \" two hundred \",\n \"date\": \"10/25/20\",\n \"status\": 0,\n \"memo\": \"First, Test check using API\",\n \"accountNumber\": \"458757\",\n \"invoiceNumber\": \"2546\",\n\t\t\t\t\t\t\t\t\"referenceId\": null,\n \"bankAccount\": {\n \"bankAccountId\": \"yd6LeMYmdQeE8Dx\",\n \"name\": \"Demo Bank Account 1\"\n },\n \"payee\": {\n \"payeeId\": \"Xw2lx48MdGMzWyD\",\n \"name\": \"Alison\"\n },\n \"category\": {\n \"categoryId\": \"OJapb4kd9GY1Ewm\",\n \"name\": \"Category 1\"\n },\n \"checkStatus\": {\n \"status\": 0,\n \"description\": \"New\"\n },\n \"checkStatements\": [\n {\n \"status\": \"created\",\n \"date\": \"09/17/2020\",\n \"time\": \"07:58 am\"\n }\n ]\n },\n {\n \"checkId\": \"bL3YGddx1yG1X7w\",\n \"serialNumber\": \"1001\",\n \"amount\": \"100.00\",\n \"amountInWord\": \" one hundred \",\n \"date\": \"10/25/20\",\n \"status\": 0,\n \"memo\": \"First, Test check using API\",\n \"accountNumber\": \"458756\",\n \"invoiceNumber\": \"2545\",\n\t\t\t\t\t\t\t\t\"referenceId\": null,\n \"bankAccount\": {\n \"bankAccountId\": \"yd6LeMYmdQeE8Dx\",\n \"name\": \"Demo Bank Account 1\"\n },\n \"payee\": {\n \"payeeId\": \"Xw2lx48MdGMzWyD\",\n \"name\": \"Alison\"\n },\n \"category\": {\n \"categoryId\": \"OJapb4kd9GY1Ewm\",\n \"name\": \"Category 1\"\n },\n \"checkStatus\": {\n \"status\": 0,\n \"description\": \"New\"\n },\n \"checkStatements\": [\n {\n \"status\": \"created\",\n \"date\": \"09/17/2020\",\n \"time\": \"07:58 am\"\n }\n ]\n },\n {\n \"checkId\": \"NlkQ4rOYo8GwnOV\",\n \"serialNumber\": \"1002\",\n \"amount\": \"200.00\",\n \"amountInWord\": \" two hundred \",\n \"date\": \"10/25/20\",\n \"status\": 0,\n \"memo\": \"First, Test check using API\",\n \"accountNumber\": \"458757\",\n \"invoiceNumber\": \"2546\",\n\t\t\t\t\t\t\t\t\"referenceId\": null,\n \"bankAccount\": {\n \"bankAccountId\": \"yd6LeMYmdQeE8Dx\",\n \"name\": \"Demo Bank Account 1\"\n },\n \"payee\": {\n \"payeeId\": \"n1ZoVelylj8pwba\",\n \"name\": \"Payee Name\"\n },\n \"category\": {\n \"categoryId\": \"OJapb4kd9GY1Ewm\",\n \"name\": \"Category 1\"\n },\n \"checkStatus\": {\n \"status\": 0,\n \"description\": \"New\"\n },\n \"checkStatements\": [\n {\n \"status\": \"created\",\n \"date\": \"09/17/2020\",\n \"time\": \"04:53 am\"\n }\n ]\n },\n {\n \"checkId\": \"0Kmz47R1YmjLOM2\",\n \"serialNumber\": \"1001\",\n \"amount\": \"100.00\",\n \"amountInWord\": \" one hundred \",\n \"date\": \"10/25/20\",\n \"status\": 0,\n \"memo\": \"First, Test check using API\",\n \"accountNumber\": \"458756\",\n \"invoiceNumber\": \"2545\",\n\t\t\t\t\t\t\t\t\"referenceId\": null,\n \"bankAccount\": {\n \"bankAccountId\": \"yd6LeMYmdQeE8Dx\",\n \"name\": \"Demo Bank Account 1\"\n },\n \"payee\": {\n \"payeeId\": \"n1ZoVelylj8pwba\",\n \"name\": \"Payee Name\"\n },\n \"category\": {\n \"categoryId\": \"OJapb4kd9GY1Ewm\",\n \"name\": \"Category 1\"\n },\n \"checkStatus\": {\n \"status\": 0,\n \"description\": \"New\"\n },\n \"checkStatements\": [\n {\n \"status\": \"created\",\n \"date\": \"09/17/2020\",\n \"time\": \"04:53 am\"\n }\n ]\n }\n ]\n }\n}"}],"_postman_id":"d359cb47-6e0f-45a6-939a-5a14a6634011"},{"name":"Retrieve a check","id":"0f399c78-12a6-43f9-9bbf-60eb11dfae70","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{AUTH_TOKEN}}"},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{AUTH_TOKEN}} ","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{BASE_URL}}/checks/{checkId}","description":"Details of an existing check.
\nPath parameters
\n| checkId | \nRequired \n The id of the check to retrieved. \n |
Update details of an existing check
\nPath parameters
\n| checkId | \nRequired \n The id of the check to update. \n |
Payload parameters
\n| bankAccountId | \n Required \n String \n Must be a bank account ID \n | \n \n
| payeeId | \n Required \n String \n Must be a payee ID\n Optional if | \n
| categoryId | \n Optional \n String \n Must be a category ID \n | \n
| serialNumber | \n Optional \n String \n By default increment every time a check is created, If a | \n
| issueDate | \n Optional \n String yyyy-mm-dd \n By default it will be current date, If a | \n
| amount | \nRequired \n Decimal \n Optional if | \n
| memo | \n Optional \n String \n Max of 150 characters to be included on the memo line of the check. \n | \n
| note | \n Optional \n String \n An internal note that identifies this check. Must be no longer than 150 characters.\n | \n
| accountNumber | \n Optional \n String \n Any account number associated with this check \n | \n
| invoiceNumber | \n Optional \n String \n Any invoice number associated with this check \n | \n
| noSign | \n Optional \n Boolean \n if | \n
| noAmount | \n Optional \n Boolean \n if | \n
| noDate | \n Optional \n Boolean \n if | \n
| noPayee | \n Optional \n Boolean \n if | \n
Permanently deletes a check.
\nPath parameters
\n| checkId | \nRequired \n The id of the check to delete. \n |
This API allows you to delete multiple checks at once by passing their IDs in a single request.
\nParameters
\nField | Required | Description |
checkIds | ✅ | A list of unique check IDs to be deleted in bulk. |
You can print checks by passing check id and paper type,if you would like to print multiple checks you need to pass checkId as array.
\nPayload parameters
\n| paperType | \nRequired \n Integer\n Must be an integer from Available |
| checkId | \nRequired \n Array\n An Array of check id to print \n |
Available paper types
| Paper type | \nDescription | \n
|---|---|
| 1 | \nCheck on Top | \n
| 2 | \nCheck on Middle | \n
| 3 | \nCheck on Bottom | \n
| 4 | \nThree per page | \n
| 5 | \nWallet size | \n
| 6 | \nSimple print | \n
You can print checks by passing check id and paper type,if you would like to print multiple checks you need to pass checkId as array.
\nPayload parameters
\npaperType | RequiredInteger Must be an integer from Available |
checkId | RequiredArray An Array of check id to print |
async | OptionalInteger |
Available _paper types_
| Paper type | Description |
|---|---|
1 | Check on Top |
2 | Check on Middle |
3 | Check on Bottom |
4 | Three per page |
5 | Wallet size |
6 | Simple print |
You can create multiple checks in one single request by passing check attributes.
If you would like to create check with advance stub you need to pass voucherId or voucher data as follow sample request.
Payload parameters
\nchecks | RequiredArray An array of |
_check_ attributes
OptionalObject
\n\nMust be an object of voucher attributes
bankAccountId | RequiredString Must be a bank account ID |
payeeId | RequiredString Must be a payee ID |
categoryId | OptionalString Must be a category ID |
serialNumber | OptionalString By default increment every time a check is created, If a |
issueDate | OptionalString By default it will be check creation date, If a |
amount | RequiredDecimal Optional if |
memo | OptionalString Max of 150 characters to be included on the memo line of the check. |
note | OptionalString An internal note that identifies this check. Must be no longer than 150 characters. |
accountNumber | OptionalString Any account number associated with this check |
invoiceNumber | OptionalString Any invoice number associated with this check |
noSign | OptionalBoolean if |
noAmount | OptionalBoolean if |
noDate | OptionalBoolean if |
noPayee | OptionalBoolean if |
voucherId | OptionalString Must be an voucher ID, It will be ignored if object of |
voucher | OptionalObject Must be an object of |
customElements | Optional Must be a key-value pair where both the key and value are strings |
htmlStub | Optional |
referenceId | Optional |
| Pay Period | September 1 - September 30, 2024 |
|---|---|
| Hours Worked | 160 |
| Hourly Rate | $25.00 |
| Gross Pay | $4,000.00 |
| Deductions | $800.00 |
| Net Pay | $3,200.00 |
Details of an existing voucher. It can be retrieve by passing checkId as well as retrieve directly by passing voucherId.
\nPath parameters
\n| checkId | \nRequired \n The id of the check to retrieve associated voucher. \n |
Void a check using CheckId
\n","urlObject":{"path":["checks","7rLdjvvZEojJEz6","void"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"38997b22-ea8a-439b-8abc-ca3959482c29","name":"Void a check","originalRequest":{"method":"POST","header":[],"url":"{{BASE_URL}}/checks/7rLdjvvZEojJEz6/void"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"success\": true,\r\n \"message\": \"Successfully Voided\"\r\n}"},{"id":"272dae5b-0ccb-4554-9ceb-83f855e9c9ac","name":"Void a check","originalRequest":{"method":"POST","header":[],"url":"{{BASE_URL}}/checks/7rLdjvvZEojJEz6/void"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"success\": false,\r\n \"errorMsg\": \"Sorry,You do not have permission to void this check\"\r\n}"}],"_postman_id":"ced07139-ebe2-48f5-bcb1-3570c83c7d3e"},{"name":"Mark as Posted","id":"7d289a0e-8b62-47ba-a9a3-be650b6565bc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{AUTH_TOKEN}}"},"isInherited":false},"method":"POST","header":[],"url":"{{BASE_URL}}/checks/6gYVew1D254dx7b/mark-as-cleared","urlObject":{"path":["checks","6gYVew1D254dx7b","mark-as-cleared"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"c9e04897-f52d-4cfd-8e40-2299ed1c64e3","name":"Mark as Posted","originalRequest":{"method":"POST","header":[],"url":"{{BASE_URL}}/checks/6gYVew1D254dx7b/mark-as-cleared"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"127.0.0.1:8000"},{"key":"Date","value":"Sat, 28 Sep 2024 11:20:49 GMT"},{"key":"Date","value":"Sat, 28 Sep 2024 11:20:49 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.4.23"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"214748364"},{"key":"X-RateLimit-Remaining","value":"214748363"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Successfully marked as cleared\"\n}"}],"_postman_id":"7d289a0e-8b62-47ba-a9a3-be650b6565bc"}],"id":"ba5158bd-ea49-4bdd-ba2a-b6286052ca12","description":"The API provides endpoints for creating multiple checks, retrieving individual checks, deleting checks, printing checks,updating checks and retrieving a list of checks.
\nCheck status and description
\n| Status code | Short description | Full description |
|---|---|---|
0 | New | New |
1 | Printed | Printed |
2 | Void | Voided |
3 | Arc | Achieved |
4 | Printing | Check Mailing - Printing |
5 | Printed | Check Mailing - Printed Your Check |
6 | Printed | Check Mailing - Printed Envelop |
7 | Mailed | Check Mailing - Mailed |
8 | Printed | Check Mailing - Mailed(Reservered For Manual Action) |
11 | Refunded | Check Mailing - Refunded (Please call our customer support & resolve the issue) |
12 | E-Mailed | E-Mailed |
13 | E-Mailed | E-Mailed |
14 | E-Printed | E-Printed |
50 | Schedule | Schedule For Future Mailing |
300 | DD | Direct Deposit |
301 | DD | Direct Deposit is not deposited from receiver |
302 | DD | Direct Deposit Initiated |
303 | DD | Direct Deposit Processing |
304 | DDC | Direct Deposit Completed |
305 | DD/F | Direct Deposit Failed |
306 | DD/V | Direct Deposit Voided |
308 | Pushing | Processing on Pushing |
311 | DD/R | Return From Provider |
312 | DD/R | Reject from Operator. Please call our customer support team for further query |
313 | DD/AR | Application Rejected |
This API endpoint allows you to create a bank account for a specified payee.
\nAvailable accountType
\n","urlObject":{"path":["payees","{{payee_id}}","bank-accounts"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"9a9d9a81-2ea4-4bd0-a826-75652103193a","name":"Create Payee Bank Account","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"bankName\": \"TestPayeeBankAccountOne\",\r\n \"routingNumber\": \"011000015\",\r\n \"accountNumber\": \"765432109876\",\r\n \"accountType\": \"businessChecking\",\r\n \"isAllowWire\": 1,\r\n \"bankAccountFirstName\": \"David\",\r\n \"bankAccountLastName\": \"Miller\",\r\n \"bankAccountAddress1\": \"321 Oak Avenue\",\r\n \"bankAccountAddress2\": \"Unit 4C\",\r\n \"bankAccountCity\": \"Boston\",\r\n \"bankAccountState\": \"MA\",\r\n \"bankAccountZip\": \"02118\",\r\n \"bankAccountCountry\": \"US\",\r\n \"bankingInstituteName\": \"CITIBANK\",\r\n \"bankingInstituteAddressLine1\": \"399 Park Avenue\",\r\n \"bankingInstituteAddressLine2\": \"\",\r\n \"bankingInstituteCity\": \"New York\",\r\n \"bankingInstituteState\": \"NY\",\r\n \"bankingInstituteZip\": 10022,\r\n \"bankingInstituteCountry\": \"US\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/payees/{{payee_id}}/bank-accounts"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"success\": true,\r\n \"data\": {\r\n \"id\": \"nv1byeVRoeOQgrB\",\r\n \"bankName\": \"TestPayeeBankAccountOne\",\r\n \"routingNumber\": \"011000015\",\r\n \"accountNumber\": \"765432109876\",\r\n \"accountType\": \"businessChecking\"\r\n }\r\n}"}],"_postman_id":"64f50e0a-7bba-4b13-a1a4-644306953d8d"},{"name":"Edit Payee Bank Account","id":"598e28e5-cb41-41d4-8842-8f1a409e8735","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{AUTH_TOKEN}}"},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"bankName\": \"TestPayeeBankAccount\",\r\n \"routingNumber\": \"011000015\",\r\n \"accountNumber\": \"65543457175487\",\r\n \"accountType\": \"SAVINGS\",\r\n \"isAllowWire\": 1,\r\n \"bankAccountFirstName\": \"TestFirstName\",\r\n \"bankAccountLastName\": \"TestLastName\",\r\n \"bankAccountAddress1\": \"1 Apple Park Way\",\r\n \"bankAccountAddress2\": \"45 amrutehshbss\",\r\n \"bankAccountCity\": \"Cupertino\",\r\n \"bankAccountState\": \"CA\",\r\n \"bankAccountZip\": \"95014\",\r\n \"bankAccountCountry\": \"US\",\r\n \"bankingInstituteName\": \"FEDERAL RESERVE BANK\",\r\n \"bankingInstituteAddressLine1\": \"1000 PEACHTREE ST N.E.\",\r\n \"bankingInstituteAddressLine2\": \"\",\r\n \"bankingInstituteCity\": \"ATLANTA\",\r\n \"bankingInstituteState\": \"GA\",\r\n \"bankingInstituteZip\": \"30309\",\r\n \"bankingInstituteCountry\": \"US\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/payees/{{payee_id}}/bank-accounts/{{payee-bankaccount-id}}","urlObject":{"path":["payees","{{payee_id}}","bank-accounts","{{payee-bankaccount-id}}"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"4600638a-d52e-4247-92c1-7dd9d62fd06d","name":"Edit Payee Bank Account","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"bankName\": \"TestPayeeBankAccount\",\r\n \"routingNumber\": \"011000015\",\r\n \"accountNumber\": \"65543457175487\",\r\n \"accountType\": \"SAVINGS\",\r\n \"isAllowWire\": 1,\r\n \"bankAccountFirstName\": \"TestFirstName\",\r\n \"bankAccountLastName\": \"TestLastName\",\r\n \"bankAccountAddress1\": \"1 Apple Park Way\",\r\n \"bankAccountAddress2\": \"45 amrutehshbss\",\r\n \"bankAccountCity\": \"Cupertino\",\r\n \"bankAccountState\": \"CA\",\r\n \"bankAccountZip\": \"95014\",\r\n \"bankAccountCountry\": \"US\",\r\n \"bankingInstituteName\": \"FEDERAL RESERVE BANK\",\r\n \"bankingInstituteAddressLine1\": \"1000 PEACHTREE ST N.E.\",\r\n \"bankingInstituteAddressLine2\": \"\",\r\n \"bankingInstituteCity\": \"ATLANTA\",\r\n \"bankingInstituteState\": \"GA\",\r\n \"bankingInstituteZip\": \"30309\",\r\n \"bankingInstituteCountry\": \"US\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/payees/{{payee_id}}/bank-accounts/{{payee-bankaccount-id}}"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"success\": true,\r\n \"data\": \"Successfully updated\"\r\n}"}],"_postman_id":"598e28e5-cb41-41d4-8842-8f1a409e8735"},{"name":"Get Payee Bank Account","id":"3f5d0af5-2a50-49b8-b044-81b9e3e43618","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{AUTH_TOKEN}}"},"isInherited":false},"method":"GET","header":[],"url":"{{BASE_URL}}/payees/{{payee_id}}/bank-accounts/{{payee-bankaccount-id}}","urlObject":{"path":["payees","{{payee_id}}","bank-accounts","{{payee-bankaccount-id}}"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"99b9cc9d-71fd-40b0-add3-8ab20bc13eaa","name":"Get Payee Bank Account","originalRequest":{"method":"GET","header":[],"url":"{{BASE_URL}}/payees/{{payee_id}}/bank-accounts/{{payee-bankaccount-id}}"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"success\": true,\r\n \"data\": {\r\n \"id\": \"mQaMdjZR5jzLxbW\",\r\n \"bankName\": \"TestPayeeBankAccount\",\r\n \"accountNumber\": \"65543457175487\",\r\n \"routingNumber\": \"011000015\",\r\n \"accountType\": \"SAVINGS\",\r\n \"isAllowWire\": 1,\r\n \"bankAccountFirstName\": \"TestFirstName\",\r\n \"bankAccountLastName\": \"TestLastName\",\r\n \"bankAccountAddress1\": \"1 Apple Park Way\",\r\n \"bankAccountAddress2\": \"45 amrutehshbss\",\r\n \"bankAccountCity\": \"Cupertino\",\r\n \"bankAccountState\": \"CA\",\r\n \"bankAccountZip\": \"95014\",\r\n \"bankAccountCountry\": \"US\",\r\n \"bankingInstituteName\": \"FEDERAL RESERVE BANK\",\r\n \"bankingInstituteAddressLine1\": \"1000 PEACHTREE ST N.E.\",\r\n \"bankingInstituteAddressLine2\": \"\",\r\n \"bankingInstituteCity\": \"ATLANTA\",\r\n \"bankingInstituteState\": \"GA\",\r\n \"bankingInstituteZip\": \"30309\",\r\n \"bankingInstituteCountry\": \"US\"\r\n }\r\n}"}],"_postman_id":"3f5d0af5-2a50-49b8-b044-81b9e3e43618"},{"name":"List Payee Bank Accounts","id":"c09ee4e9-3fa1-47f4-975e-d3b258f15763","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{AUTH_TOKEN}}"},"isInherited":false},"method":"GET","header":[],"url":"{{BASE_URL}}/payees/{{payee_id}}/bank-accounts/","urlObject":{"path":["payees","{{payee_id}}","bank-accounts",""],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"158e05f6-e280-4f75-b8de-9140a9243284","name":"List Payee Bank Accounts","originalRequest":{"method":"GET","header":[],"url":""},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"success\": true,\r\n \"data\": [\r\n {\r\n \"id\": \"36gYVewQb4dx7bD\",\r\n \"bankName\": \"TestPayeeBankAccount\",\r\n \"accountNumber\": \"65543457875487\",\r\n \"routingNumber\": \"011000015\",\r\n \"accountType\": \"SAVINGS\",\r\n \"defaultDDAccount\": 1,\r\n \"defaultCDAccount\": 0,\r\n \"verified\": null\r\n }\r\n ]\r\n}"}],"_postman_id":"c09ee4e9-3fa1-47f4-975e-d3b258f15763"},{"name":"Delete Payee Bank Account","id":"41551674-4b6f-4115-84ee-6a9fac30275b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{AUTH_TOKEN}}"},"isInherited":false},"method":"DELETE","header":[],"url":"{{BASE_URL}}/payees/{{payee_id}}/bank-accounts/{{payee-bankaccount-id}}","urlObject":{"path":["payees","{{payee_id}}","bank-accounts","{{payee-bankaccount-id}}"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"265a5f53-cc42-42d3-b522-cc8224f68060","name":"Delete Payee Bank Account","originalRequest":{"method":"DELETE","header":[],"url":"{{BASE_URL}}/payees/{{payee_id}}/bank-accounts/{{payee-bankaccount-id}}"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"success\": true,\r\n \"data\": \"Deleted Successfully\"\r\n}"}],"_postman_id":"41551674-4b6f-4115-84ee-6a9fac30275b"}],"id":"4cbf0769-8bd3-4a3c-9524-05a9fcdb1472","_postman_id":"4cbf0769-8bd3-4a3c-9524-05a9fcdb1472","description":""},{"name":"Retrieve all payees","id":"76b41923-ddd7-4ed6-b3cd-67c95afb0e4f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{AUTH_TOKEN}}"},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{BASE_URL}}/payees?perPage=&page=&term=","description":"List all payee records.
\nQuery parameters
\n| perPage | \nNumber of records that you want to receive in the response,By default 10 records will be \n listed | \n
| page | \nFor navigating through pages ,By default first page will be listed | \n
| term | \nFilter records by using any keywords | \n
Number of records that you want to receive in the response,By default 10 records will be listed
\n","type":"text/plain"},"key":"perPage","value":""},{"description":{"content":"By default first page will be listed
\n","type":"text/plain"},"key":"page","value":""},{"description":{"content":"Filter records by using any keywords
\n","type":"text/plain"},"key":"term","value":""}],"variable":[]}},"response":[{"id":"c2de1755-9fb0-43c5-9e37-04687f809457","name":"Retrieve all payees","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{AUTH_TOKEN}} ","type":"text","disabled":true},{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{BASE_URL}}/payees?perPage&page&term","host":["{{BASE_URL}}"],"path":["payees"],"query":[{"key":"perPage","value":null},{"key":"page","value":null},{"key":"term","value":null}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8000"},{"key":"Date","value":"Thu, 15 Oct 2020 10:53:59 GMT"},{"key":"Date","value":"Thu, 15 Oct 2020 10:53:59 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.3.11"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"48"},{"key":"phpdebugbar-id","value":"X85ce2ba7d882d2e6aecbf8796afd45f3"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"meta\": {\n \"total\": 2,\n \"currentPage\": 1,\n \"perPage\": 10\n },\n \"payees\": [\n {\n \"payeeId\": \"Xw2lx48MdGMzWyD\",\n \"name\": \"Alison\",\n \"nickName\": null,\n \"company\": null,\n \"email\": \"email@test.com\",\n \"phone\": \"900244400\",\n \"address1\": \"95113 mark street rod\",\n \"address2\": null,\n \"city\": \"Sanjose\",\n \"state\": \"CA\",\n \"zip\": \"95113\",\n \"country\": \"US\"\n },\n {\n \"payeeId\": \"mQ0bRG235eZdP3x\",\n \"name\": \"Alison Gambala\",\n \"nickName\": null,\n \"company\": null,\n \"email\": \"email@test.com\",\n \"phone\": \"900244400\",\n \"address1\": \"95113 mark street rod\",\n \"address2\": null,\n \"city\": \"Sanjose\",\n \"state\": \"CA\",\n \"zip\": \"95113\",\n \"country\": \"US\"\n }\n ]\n }\n}"}],"_postman_id":"76b41923-ddd7-4ed6-b3cd-67c95afb0e4f"},{"name":"Retrieve a payee","id":"d59ba682-8352-4340-92cb-27bbf4b9a0a8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{AUTH_TOKEN}}"},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{AUTH_TOKEN}} ","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{BASE_URL}}/payees/{payeeId}","description":"Details of an existing payee.
\nPath parameters
\n| payeeId | \nRequired \n The id of the payee to retrieve \n |
Permanently deletes a payee.
\nPath parameters
\n| payeeId | \nRequired \n The id of the payee to delete \n |
Update details of an existing payee.
\nPath parameters
\npayeeId | Required The id of the payee to update |
Payload parameters
\nname | RequiredString Name of payee,Must be no longer than 100 characters. |
nickName | OptionalString Nick name of payee,Must be no longer than 50 characters. |
company | OptionalString Company name,Must be no longer than 50 characters. |
email | OptionalString Must be no longer than 90 characters. |
phone | OptionalString Must be no longer than 15 characters. |
address1 | OptionalString Must be no longer than 180 characters. |
address2 | OptionalString Must be no longer than 180 characters. |
city | OptionalString Must be no longer than 180 characters. |
state | OptionalString Must be a 2 letter state short-name code |
zip | OptionalString Must be no longer than 15 characters. |
country | OptionalString Must be no longer than 40 characters. |
dob | Optional String Date of birth, Must be in the format YYYY-MM-DD. |
You can create multiple payees in one single request by passing payee attributes.
\nPayload parameters
\npayees | Required An array of |
_payee_ attributes
name | RequiredString Name of payee,Must be no longer than 100 characters. |
nickName | OptionalString Nick name of payee,Must be no longer than 50 characters. |
company | OptionalString Company name,Must be no longer than 50 characters. |
email | OptionalString Must be no longer than 90 characters. |
phone | OptionalString Must be no longer than 15 characters. |
address1 | OptionalString Must be no longer than 180 characters. |
address2 | OptionalString Must be no longer than 180 characters. |
city | OptionalString Must be no longer than 180 characters. |
state | OptionalString Must be a 2 letter state short-name code |
zip | OptionalString Must be no longer than 15 characters. |
country | OptionalString Must be no longer than 40 characters. |
dob | Optional String Date of birth, Must be in the format YYYY-MM-DD. |
The API provides endpoints for creating multiple payees, retrieving individual payees, deleting payees,updating payee and retrieving a list of payees.
\n","_postman_id":"ffb7536b-f469-47cb-880c-8afebc60c678"},{"name":"MailCheck","item":[{"name":"Attachments","item":[{"name":"Retrieve all mail attachments","id":"259bcf29-4d8b-4e86-b808-20daa20123cd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{AUTH_TOKEN}}"},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","type":"text","value":"application/json"}],"url":"{{BASE_URL}}/mailchecks/{checkId}/attachments","description":"List of all mail attachments on a check,This attachments will include when create mail with this check.
\nPath parameters
\n| checkId | \nRequired \n Id of the Check. \n |
PDF attachment
\n","type":"file","src":"/C:/Users/Tyler/Downloads/Online Check Writer (25).pdf"},{"key":"fileUrl","value":"","description":"Remote PDF Url
\n","type":"text"}]},"url":"{{BASE_URL}}/mailchecks/{checkId}/attachments","description":"This API allows you to upload PDF file as attachment,\nThere are two types of uploads you can perform:\nUpload via remote URL with, (fileUrl)\nYou can provide any remote public accessible url as ’fileUrl’ parameter , this file will be fetched and will be added as attachment
\nSimple Upload (attachment),
You can directly upload the file via post method
Path parameters
\n| checkId | \nRequired \n Id of the Check. \n |
Payload parameters
\n| attachment | \nRequired \n File\n File of type pdf,Optional if | \n
| fileUrl | \nRequired \n String\n Must be a public accessible url ,Optional if | \n
Path parameters
\n| checkId | \nRequired \n Id of the Check. \n | \n
| mailAttachmentId | \nRequired \n Id of the mail attachment. \n | \n
If you would like to attach any file with mail check,You can use these end points,The API provides endpoints for uploading attachment/adding remote url, retrieving all mail attachments and deleting mail attachments.
\n","_postman_id":"c17fa001-35ce-49fa-b297-b36e4cf42691"},{"name":"Retrieve all mail options","id":"95500cb7-f74f-4e41-93d6-1752eb33977d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{AUTH_TOKEN}}"},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","type":"text","value":"application/json"}],"url":"{{BASE_URL}}/mailchecks/mailingOptions","description":"Retrieve all available mail options,including shipping types,Paper types and Inform types,You can use this data to create mail check.
\n","urlObject":{"path":["mailchecks","mailingOptions"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"69b131f9-e923-4c8f-b33e-5049cc3a6b2f","name":"Retrieve all mail options","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","type":"text","value":"application/json"}],"url":"{{BASE_URL}}/mailchecks/mailingOptions"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8000"},{"key":"Date","value":"Sun, 13 Dec 2020 06:47:12 GMT"},{"key":"Date","value":"Sun, 13 Dec 2020 06:47:12 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.3.11"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"100"},{"key":"X-RateLimit-Remaining","value":"77"},{"key":"phpdebugbar-id","value":"X64472eae8df2f9441769cabafdf716a8"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"informTypes\": [\n {\n \"informTypeId\": 10,\n \"name\": \"Notify Receiver by Sms\",\n \"amount\": \"0.50\",\n \"shortCode\": \"\"\n }\n ],\n \"shippingTypes\": [\n {\n \"shippingTypeId\": 3,\n \"name\": \"First Class with Tracking\",\n \"amount\": \"3.50\",\n \"shortCode\": \"F-T\"\n },\n {\n \"shippingTypeId\": 1,\n \"name\": \"First Class\",\n \"amount\": \"1.00\",\n \"shortCode\": \"F\"\n },\n {\n \"shippingTypeId\": 11,\n \"name\": \"Fedex 2 days Shipping\",\n \"amount\": \"49.99\",\n \"shortCode\": \"F_2_D\"\n },\n {\n \"shippingTypeId\": 12,\n \"name\": \"Standard Overnight -Fedex-By 3pm the next business day\",\n \"amount\": \"69.99\",\n \"shortCode\": \"F_S_O\"\n },\n {\n \"shippingTypeId\": 4,\n \"name\": \"Priority Mail\",\n \"amount\": \"8.99\",\n \"shortCode\": \"P\"\n },\n {\n \"shippingTypeId\": 5,\n \"name\": \"Express Mail\",\n \"amount\": \"29.99\",\n \"shortCode\": \"E\"\n }\n ],\n \"paperTypes\": [\n {\n \"paperTypeId\": 7,\n \"name\": \"Regular Check Paper\",\n \"amount\": \"0.00\",\n \"shortCode\": \"N\"\n },\n {\n \"paperTypeId\": 8,\n \"name\": \"Hollogram Check Paper\",\n \"amount\": \"0.50\",\n \"shortCode\": \"H\"\n },\n {\n \"paperTypeId\": 9,\n \"name\": \"Ultra Hollogram Check Paper\",\n \"amount\": \"0.99\",\n \"shortCode\": \"U\"\n }\n ]\n }\n}"}],"_postman_id":"95500cb7-f74f-4e41-93d6-1752eb33977d"},{"name":"Create new mail check","id":"f4562b65-70e8-4c4d-8444-8898e61ab7f0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{AUTH_TOKEN}}"},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"\r\n {\r\n \r\n \"mailChecks\" : [\r\n {\r\n \"checkId\" :\"bL3YGddEnmG1X7w\", \r\n \"shippingTypeId\" :3,\r\n \"paperTypeId\" :7,\r\n \"informTypeId\" :10,\r\n \"enableSmsInform\" :0,\r\n \"enableEmailInform\" :1,\r\n \"payeeEmail\" :\"email@test.com\",\r\n \"payeePhone\" :\"123456789\"\r\n }\r\n \r\n ]\r\n }\r\n \r\n\r\n\r\n "},"url":"{{BASE_URL}}/mailchecks","description":"You can create multiple checks in one single request
\nPayload parameters
\nisShippingToCustomAddress | OptionalBoolean Value is |
customFromAddressId | OptionalString Must be custom from address ID ,Required if |
customToAddressId | OptionalString Must be custom to address ID ,Required if |
customShippingTypeId | OptionalString Must be valid |
mailChecks | RequiredArray An array of |
_mailChecks_ attributes
checkId | RequiredString Must be a check ID |
shippingTypeId | RequiredInteger Must be a valid |
paperTypeId | RequiredInteger Must be a valid |
informTypeId | OptionalInteger Must be a valid |
enableSmsInform | OptionalBoolean By default |
enableEmailInform | OptionalBoolean By default |
payeeEmail | OptionalString Required if |
payeePhone | OptionalString Required if |
Shipping Types
\n| Shipping Type Id | Description |
|---|---|
1 | First Class |
3 | First Class with Tracking |
4 | Priority Mail |
5 | Express Mail |
12 | Standard Overnight -Fedex-By 3pm the next business day |
20 | Fedex Satureday Delivery |
Paper Types
\n| Paper Type Id | Description |
|---|---|
7 | Regular Check Paper |
8 | Hollogram Check Paper |
9 | Ultra Hollogram Check Paper |
Inform Types
\n| Inform Type Id | Description |
|---|---|
10 | Notify Receiver by Sms |
You can calculate check mail fees by using same mail creation payload parameters.
\n","urlObject":{"path":["mailchecks","calculateFee"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"1a0322c6-7e56-4219-92cb-c729913dc06c","name":"Calculate Fee","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"\r\n {\r\n \"isShippingToCustomAddress\" :true,\r\n \"customFromAddressId\" :\"5mQ0bRG2q4ZdP3x\",\r\n \"customToAddressId\" :\"5mQ0bRG2q4ZdP3x\",\r\n \"customShippingTypeId\" :5,\r\n \"mailChecks\" : [\r\n {\r\n \"checkId\" :\"1ZoVelOY2QG8pwb\", \r\n \"shippingTypeId\" :3,\r\n \"paperTypeId\" :7,\r\n \"informTypeId\" :10,\r\n \"enableSmsInform\" :0,\r\n \"enableEmailInform\" :1,\r\n \"payeeEmail\" :\"email@test.com\",\r\n \"payeePhone\" :\"123456789\"\r\n },\r\n {\r\n \"checkId\" :\"Q0bRG21rZQ4ZdP3\", \r\n \"shippingTypeId\" :5,\r\n \"paperTypeId\" :7,\r\n \"informTypeId\" :10,\r\n \"enableSmsInform\" :0,\r\n \"enableEmailInform\" :0,\r\n \"payeeEmail\" :\"email@test.com\",\r\n \"payeePhone\" :\"123456789\"\r\n }\r\n\r\n ]\r\n }\r\n \r\n\r\n\r\n "},"url":"{{BASE_URL}}/mailchecks/calculateFee"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8000"},{"key":"Date","value":"Sun, 13 Dec 2020 06:27:07 GMT"},{"key":"Date","value":"Sun, 13 Dec 2020 06:27:07 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.3.11"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"100"},{"key":"X-RateLimit-Remaining","value":"80"},{"key":"phpdebugbar-id","value":"Xd1e43235e5fdf8d32b4f0e59faf2f31c"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"currentBalance\": \"933.02\",\n \"isShippingToCustomAddress\": true,\n \"itemWisePrice\": [\n \"0.80\",\n \"0.80\"\n ],\n \"customShippingFee\": \"29.99\",\n \"subTotal\": \"1.60\",\n \"total\": \"31.59\"\n }\n}"}],"_postman_id":"61c1620d-2106-43ef-b417-f32bb46cdf91"},{"name":"Track Mail Check","id":"a797e883-bb0c-44a1-aa49-cb78162a7bcd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{AUTH_TOKEN}}"},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{BASE_URL}}/mailchecks/{checkId}/tracking","description":"Response Data
\ncarrier | Carrier name (USPS,Fedex) |
trackingCode | Tracking code number |
status | Current status of the tracking ('pre_transit','in_transit','delivered','error','unknown','out_for_delivery','return_to_sender' or 'cancelled') |
estimatedDeliveryDate | Estimated delivery date |
trackingDetails | Tracking updates details |
The API provides endpoints for creating multiple mail checks,retrieve all available mail options and calculate fee
\nHow to get tracking details :
\napi/v3/mailchecks/{id}/tracking
\n","event":[{"listen":"prerequest","script":{"id":"784dfd1b-728a-47b4-83dc-c88bac1a9f1b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"bac5fa4c-9f48-4154-aeda-0ef4a3458757","type":"text/javascript","exec":[""]}}],"_postman_id":"f741e201-fb78-422d-97d7-ef4a8a4c35bb"},{"name":"Mail Document","item":[{"name":"Html File Mailing","item":[{"name":"Create","id":"7054e611-97f9-4e37-b842-9886ec42691b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","value":null},{"key":"idempotency_key","value":"","type":"text"},{"key":"document_title","value":"","type":"text"}]},"url":"{{BASEURL}}/documentmailing/template/upload","urlObject":{"path":["documentmailing","template","upload"],"host":["{{BASEURL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"7054e611-97f9-4e37-b842-9886ec42691b"},{"name":"Mail Html","id":"1b829f0a-673b-4154-869d-96876fe511ab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"template_id","value":"","type":"text","description":"required
\n"},{"key":"reply_id","value":"","type":"text","description":"required
\n"},{"key":"shipping_type","value":"","type":"text","description":"required
\n"},{"key":"json_content","value":"","type":"text","description":"required
\n"},{"key":"payee_id","value":"","description":"required
\n","type":"text"}]},"url":"{{BASEURL}}/documentmailing/template/mail","urlObject":{"path":["documentmailing","template","mail"],"host":["{{BASEURL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"1b829f0a-673b-4154-869d-96876fe511ab"}],"id":"66169f70-2815-4b45-ba4f-5f1f5496c46f","description":"Create your invoice/document/template in HTML with dynamic elements such as {name}, {invoice}. Then, call another API to generate a new PDF with those values and submit the PDF to your recipient.
\nVideo tutorial : https://youtu.be/zDKDXEVIr1M
\n","_postman_id":"66169f70-2815-4b45-ba4f-5f1f5496c46f"},{"name":"Pdf Mailing","item":[{"name":"Mail","id":"878daf05-e36e-44a2-bce8-15f24d72f82e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{AUTH_TOKEN}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"document_details[title]","value":"Title Docuemnt","type":"text"},{"key":"document_details[file]","type":"file","fileNotInWorkingDirectoryWarning":"This file isn't in your working directory. Teammates you share this request with won't be able to use this file. To make collaboration easier you can setup your working directory in Settings.","filesNotInWorkingDirectory":["/C:/Users/YASIR/Downloads/Mail-Report-2023-12-30-10-27-44-381244.pdf","/C:/Users/TP/Desktop/document_mailing/document_mailing.pdf"],"src":["/C:/Users/YASIR/Downloads/Mail-Report-2023-12-30-10-27-44-381244.pdf","/C:/Users/TP/Desktop/document_mailing/document_mailing.pdf"]},{"key":"shipping[shippingTypeId]","value":"3","type":"text"},{"key":"from_address[name]","value":"","type":"text"},{"key":"from_address[company]","value":"","type":"text"},{"key":"from_address[address1]","value":"","type":"text"},{"key":"from_address[address2]","value":"","type":"text"},{"key":"from_address[city]","value":"","type":"text"},{"key":"from_address[state]","value":"","type":"text"},{"key":"from_address[zip]","value":"","type":"text"},{"key":"from_address[phone]","value":"","type":"text"},{"key":"from_address[email]","value":"","type":"text"},{"key":"destination[name]","value":"","type":"text"},{"key":"destination[company]","value":"","type":"text"},{"key":"destination[address1]","value":"","type":"text"},{"key":"destination[address2]","value":"","type":"text"},{"key":"destination[city]","value":"","type":"text"},{"key":"destination[state]","value":"","type":"text"},{"key":"destination[zip]","value":"","type":"text"},{"key":"destination[phone]","value":"","type":"text"},{"key":"destination[email]","value":"","type":"text"}]},"url":"{{BASE_URL}}/documentmailing/mail","description":"shippingTypeId
\n","urlObject":{"path":["documentmailing","mail"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"878daf05-e36e-44a2-bce8-15f24d72f82e"}],"id":"c82b406c-defe-44e8-9d51-0a2f05c74574","_postman_id":"c82b406c-defe-44e8-9d51-0a2f05c74574","description":""},{"name":"Upload Doc","item":[{"name":"Upload Document","id":"77c95f2c-0d30-4ce8-a3bc-3722fa8dcbec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{AUTH_TOKEN}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"document_title","value":"Invoice Document\n","type":"text"},{"key":"file","description":"only allowed is pdf
\n","type":"file","fileNotInWorkingDirectoryWarning":"This file isn't in your working directory. Teammates you share this request with won't be able to use this file. To make collaboration easier you can setup your working directory in Settings.","filesNotInWorkingDirectory":["/C:/Users/TP/Desktop/document_mailing/document_mailing.pdf"],"src":"/C:/Users/TP/Desktop/document_mailing/document_mailing.pdf"},{"key":"idempotency_key","value":"0fdf5fef-bc89-4e81-9382-44bd44aad773","type":"text"}]},"url":"{{BASE_URL}}/documentmailing/upload","urlObject":{"path":["documentmailing","upload"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"ff3e58e7-0a47-4a9b-ae8a-1027224053b4","name":"Upload Document","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"document_title","value":"Certificate of Completion 2023","type":"text"},{"key":"file","type":"file","fileNotInWorkingDirectoryWarning":"This file isn't in your working directory. Teammates you share this request with won't be able to use this file. To make collaboration easier you can setup your working directory in Settings.","filesNotInWorkingDirectory":["/C:/Users/TP/Desktop/document_mailing/dummy.pdf"],"src":"/C:/Users/TP/Desktop/document_mailing/dummy.pdf"},{"key":"idempotency_key","value":"69356452-c7fc-49a9-8bfc-f01f9e5c5aa1","type":"text"}]},"url":"{{BASE_URL}}/documentmailing/upload"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 04 Mar 2024 21:05:14 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"58"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Frame-Options","value":"ALLOWALL"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": \"Xw2lx4820eMzWyD\",\n \"document_title\": \"Certificate of Completion 2023\",\n \"document_name\": \"document_mailing/819096/1709586314-dummy.pdf\"\n }\n}"}],"_postman_id":"77c95f2c-0d30-4ce8-a3bc-3722fa8dcbec"}],"id":"29aa621b-2dfe-4d9a-88f9-7933bd8449de","description":"Upload document can be used to upload important documents inside OnlineCheckWriter, which can be mailed later from the OnlineCheckWriter UI
\n","_postman_id":"29aa621b-2dfe-4d9a-88f9-7933bd8449de"},{"name":"Sender Address","item":[{"name":"add","id":"efeb0e2e-505b-4156-82db-bec99265fd44","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\":\"Abc Tracking Samle \",\r\n \"nickName\":\"\",\r\n \"company\":\"ABC SAMPLE\",\r\n \"address1\":\"5007 richmond rd\",\r\n \"address2\":\"\",\r\n \"city\":\"Tyler\",\r\n \"state\":\"TX\",\r\n \"zip\":\"75703\",\r\n\t\t\"phone\":\"21245645\",\r\n \"email\":\"support@onlinecheckwriter.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/documentmailing/sender/add","urlObject":{"path":["documentmailing","sender","add"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"efeb0e2e-505b-4156-82db-bec99265fd44"},{"name":"delete","id":"a661877a-d626-49bb-8e35-ddda079c1af3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/documentmailing/sender/delete/{id}","urlObject":{"path":["documentmailing","sender","delete","{id}"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a661877a-d626-49bb-8e35-ddda079c1af3"}],"id":"a881ef27-7c2c-4ae0-9502-40c5109612ae","_postman_id":"a881ef27-7c2c-4ae0-9502-40c5109612ae","description":""},{"name":"Tracking","item":[{"name":"Get","id":"7437af04-19a7-46a9-aa19-4e0c21b47559","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{BASE_URL}}/documentmailing/tracking/{documentId}","urlObject":{"path":["documentmailing","tracking","{documentId}"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"7437af04-19a7-46a9-aa19-4e0c21b47559"}],"id":"96d756fe-2bd0-476a-ba9c-256a9b6917d2","_postman_id":"96d756fe-2bd0-476a-ba9c-256a9b6917d2","description":""},{"name":"Get Reply To Address","id":"c3cd4a47-16be-4d4b-897d-c0d26654ed56","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{BASE_URL}}/documentmailing/getreplyto?perPage=10&terms=","urlObject":{"path":["documentmailing","getreplyto"],"host":["{{BASE_URL}}"],"query":[{"description":{"content":"The default value is 10, with a maximum of 100.
\n","type":"text/plain"},"key":"perPage","value":"10"},{"description":{"content":"We will search using these terms or keywords within the name, company name, phone, and email. If there's a match, you will receive results. This helps narrow down your search.
\n","type":"text/plain"},"key":"terms","value":""}],"variable":[]}},"response":[{"id":"4df25f74-1575-45f6-a331-bc35039bd948","name":"Get Reply To Address","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{BASE_URL}}/documentmailing/getreplyto?perPage=10&terms","host":["{{BASE_URL}}"],"path":["documentmailing","getreplyto"],"query":[{"key":"perPage","value":"10","description":"The default value is 10, with a maximum of 100."},{"key":"terms","value":null,"description":"We will search using these terms or keywords within the name, company name, phone, and email. If there's a match, you will receive results. This helps narrow down your search."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"127.0.0.1:8000"},{"key":"Date","value":"Mon, 04 Mar 2024 19:42:21 GMT"},{"key":"Date","value":"Mon, 04 Mar 2024 19:42:21 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.4.4"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"meta\": {\n \"total\": 3,\n \"currentPage\": 1,\n \"perPage\": \"10\"\n },\n \"relyToAddress\": [\n {\n \"id\": \"rz6VoW41dj589lK\",\n \"name\": \"1123\",\n \"company\": null,\n \"email\": null,\n \"phone\": \"(123) 132-1231\",\n \"address1\": \"32132\",\n \"address2\": \"132123\",\n \"city\": \"1231\",\n \"state\": \"2313\",\n \"zip\": \"7546556564\",\n \"country\": \"US\"\n },\n {\n \"id\": \"qx5NrWjymj2n3l6\",\n \"name\": \"Tyker Petroleum Inc-2\",\n \"company\": null,\n \"email\": null,\n \"phone\": \"(901) 456-4564\",\n \"address1\": \"5005 Old Jacksonville Highway\",\n \"address2\": null,\n \"city\": \"Tyler\",\n \"state\": \"TX\",\n \"zip\": \"75703\",\n \"country\": \"US\"\n },\n {\n \"id\": \"y0bL3YGdLG1X7wA\",\n \"name\": \"Sabeer Nc\",\n \"company\": null,\n \"email\": \"support@onlinecheckwriter.com\",\n \"phone\": \"9032454511\",\n \"address1\": \"47 W 13th St\",\n \"address2\": null,\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"zip\": \"10011\",\n \"country\": \"US\"\n }\n ]\n }\n}"}],"_postman_id":"c3cd4a47-16be-4d4b-897d-c0d26654ed56"}],"id":"366c6da3-4691-4233-9f3e-3b02da2817d2","description":"Sometimes, you want to mail your documents. Using ZilMoney/OnlineCheckWriter API, you will be able to send documents easily. We just need a few pieces of information.
\nThis From/ReplyToAddress field is optional. If not provided, the system will automatically default to one of Zilmoney's location addresses (subject to change). Alternatively, if you have the ID, you can also include it
\n","_postman_id":"366c6da3-4691-4233-9f3e-3b02da2817d2"},{"name":"Custom From Address","item":[{"name":"Retrieve all Custom from addresses","id":"e2ad5da8-1c31-4642-ae93-068f99171da4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{AUTH_TOKEN}}"},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{BASE_URL}}/customFromAddresses","description":"List of all custom from address records.
\nQuery parameters
\n| perPage | \nNumber of records that you want to receive in the response,By default 10 records will be \n listed | \n
| page | \nFor navigating through pages ,By default first page will be listed | \n
Details of custom from address.
\nPath parameters
\n| customFromAddressId | \nRequired \n The id of the Custom from address to be retrieved. \n |
Permanently deletes a custom from address.
\nPath parameters
\n| customFromAddressId | \nRequired \n The id of the Custom from address to be delete. \n |
Update details of an existing custom from address
\nPath parameters
\n| customFromAddressId | \nRequired \n The id of the Custom from address to be update. \n |
Payload parameters
\n| name | \nRequired\n String \n Must be no longer than 50 characters. \n | \n
| companyName | \nOptional \n String\n Must be no longer than 50 characters. \n | \n
| addressLine1 | \nRequired\n String\n Must be no longer than 100 characters. \n | \n
| addressLine2 | \nRequired \n String\n Must be no longer than 100 characters. \n | \n
| city | \nRequired \n String\n Must be no longer than 100 characters. \n | \n
| state | \nRequired \n String\n Must be a 2 letter state short-name code \n | \n
| zip | \nRequired \n String\n Must be no longer than 15 characters. \n | \n
| phone | \nOptional \n String\n Must be no longer than 15 characters. \n | \n
| Optional \n String\n Must be no longer than 15 characters. \n | \n|
| note | \nOptional \n String\n An internal note that identifies this address,Must be no longer than 200 characters. \n | \n
Create a custom from address
\nPayload parameters
\n| name | \nRequired\n String \n Must be no longer than 50 characters. \n | \n
| companyName | \nOptional \n String\n Must be no longer than 50 characters. \n | \n
| addressLine1 | \nRequired\n String\n Must be no longer than 100 characters. \n | \n
| addressLine2 | \nRequired \n String\n Must be no longer than 100 characters. \n | \n
| city | \nRequired \n String\n Must be no longer than 100 characters. \n | \n
| state | \nRequired \n String\n Must be a 2 letter state short-name code \n | \n
| zip | \nRequired \n String\n Must be no longer than 15 characters. \n | \n
| phone | \nOptional \n String\n Must be no longer than 15 characters. \n | \n
| Optional \n String\n Must be no longer than 15 characters. \n | \n|
| note | \nOptional \n String\n An internal note that identifies this address,Must be no longer than 200 characters. \n | \n
If you would like to send mailcheck from custom address,then you can create custom from address and pass Id with mailcheck,The API provides endpoints for creating custom from address, retrieving individual custom from address,updating custom from address, deleting custom from address, and retrieving a list of custom from address.
\n","_postman_id":"919a9539-d038-4d4b-a814-a0c43b4a0bc2"},{"name":"Custom To Address","item":[{"name":"Retrieve all Custom to addresses","id":"372369b2-f9f8-4d82-8fcf-72c365862295","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{AUTH_TOKEN}}"},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{BASE_URL}}/customToAddresses","description":"List of all custom to address records
\nQuery parameters
\n| perPage | \nNumber of records that you want to receive in the response,By default 10 records will be \n listed | \n
| page | \nFor navigating through pages ,By default first page will be listed | \n
Details of custom to address.
\nPath parameters
\n| customToAddressId | \nRequired \n The id of the Custom to address to be retrieve. \n |
Permanently deletes a custom to address.
\nPath parameters
\n| customToAddressId | \nRequired \n The id of the Custom to address to be delete. \n |
Update details of an existing custom to address
\nPath parameters
\n| customToAddressId | \nRequired \n The id of the Custom to address to be update. \n |
Payload parameters
\n| name | \nRequired\n String \n Must be no longer than 50 characters. \n | \n
| companyName | \nOptional \n String\n Must be no longer than 50 characters. \n | \n
| addressLine1 | \nRequired\n String\n Must be no longer than 100 characters. \n | \n
| addressLine2 | \nRequired \n String\n Must be no longer than 100 characters. \n | \n
| city | \nRequired \n String\n Must be no longer than 100 characters. \n | \n
| state | \nRequired \n String\n Must be a 2 letter state short-name code \n | \n
| zip | \nRequired \n String\n Must be no longer than 15 characters. \n | \n
| phone | \nOptional \n String\n Must be no longer than 15 characters. \n | \n
| Optional \n String\n Must be no longer than 15 characters. \n | \n|
| note | \nOptional \n String\n An internal note that identifies this address,Must be no longer than 200 characters. \n | \n
Create a custom to address
\nPayload parameters
\n| name | \nRequired\n String \n Must be no longer than 50 characters. \n | \n
| companyName | \nOptional \n String\n Must be no longer than 50 characters. \n | \n
| addressLine1 | \nRequired\n String\n Must be no longer than 100 characters. \n | \n
| addressLine2 | \nRequired \n String\n Must be no longer than 100 characters. \n | \n
| city | \nRequired \n String\n Must be no longer than 100 characters. \n | \n
| state | \nRequired \n String\n Must be a 2 letter state short-name code \n | \n
| zip | \nRequired \n String\n Must be no longer than 15 characters. \n | \n
| phone | \nOptional \n String\n Must be no longer than 15 characters. \n | \n
| Optional \n String\n Must be no longer than 15 characters. \n | \n|
| note | \nOptional \n String\n An internal note that identifies this address,Must be no longer than 200 characters. \n | \n
If you would like to send mailcheck to custom address,then you can create custom to address and pass Id with mailcheck,The API provides endpoints for creating custom to address, retrieving individual custom to address, deleting custom to address,updating custom to address and retrieving a list of custom to address.
\n","_postman_id":"3e3c975c-1836-48c3-8a76-fbc34a71ebfc"},{"name":"Email Check","item":[{"name":"Create Email Check","id":"3deabe4b-f826-4349-b18b-dfe9acfa75d8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{AUTH_TOKEN}}"},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{AUTH_TOKEN}} ","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"emailChecks\" :[ {\r\n \"checkId\" :\"{{checkId}}\",\r\n \"payeeEmail\" :\"test1000@test.com\",\r\n \"enableSmsInform\" :true,\r\n \"payeePhone\" :null\r\n }\r\n \r\n ]\r\n}"},"url":"{{BASE_URL}}/emailchecks","description":"You can create multiple Email check in one single request.
\nPayload parameters
\n| emailChecks | Required An array of |
emailCheck attributes
| checkId | Required Must be a check ID |
| payeeEmail | Optional Required if not exist any email on associated payee |
| enableSmsInform | Optional Notify your payee through SMS, By default |
| payeePhone | Optional Required if |
| sendAttachment | Optional Possible values : 0 or 1. This will send added attachments along with the check. |
The API provides endpoints for creating multiple email checks,
\n","_postman_id":"06622b84-c8b9-4612-9f78-7516058e5c1b"},{"name":"Category","item":[{"name":"Retrieve all Categories","id":"e59b8a62-c6d3-4ed2-b1f2-50a2c7e38373","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{AUTH_TOKEN}}"},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{AUTH_TOKEN}} ","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{BASE_URL}}/categories","description":"List of all category records.
\nQuery parameters
\n| perPage | \nNumber of records that you want to receive in the response,By default 10 records will be \n listed | \n
| page | \nFor navigating through pages ,By default first page will be listed | \n
| term | \nFilter records by using any keywords | \n
Create a category
\nPayload parameters
\n| name | \nRequired \n String \n Must be no longer than 50 characters. \n | \n
| type | \nRequired \n String \n Must be either | \n
If you would like to add any category while creating check ,you can use these endpoints. The API provides endpoints for creating categories, and retrieving a list of categories.
\n","_postman_id":"fd414724-ac70-4f33-8f06-3dede7e4d209"},{"name":"Voucher","item":[{"name":"Create voucher","id":"85eca962-b68a-44c3-a5df-1644b825a1ea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{AUTH_TOKEN}}"},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{AUTH_TOKEN}} ","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\r\n \"voucherNumber\" :\"1000\",\r\n \"memo\" :\"Test Memo\",\r\n \"date\" :\"2020-10-20\",\r\n \"payeeId\" :null,\r\n \"voucherItems\" :[\r\n {\r\n \"invoiceNumber\" :540,\r\n \"name\" :\"Product 1\",\r\n \"description\" :\"Product Description 1\",\r\n \"quantity\" :null,\r\n \"unitCost\" :null,\r\n \"total\" :200\r\n },\r\n {\r\n \"invoiceNumber\" :541,\r\n \"name\" :\"Product 2\",\r\n \"description\" :\"Product Description 2\",\r\n \"quantity\" :4,\r\n \"unitCost\" :null,\r\n \"total\" :200\r\n },\r\n {\r\n \"invoiceNumber\" :545,\r\n \"name\" :\"Product 2\",\r\n \"description\" :\"Product Description 2\",\r\n \"quantity\" :5,\r\n \"unitCost\" :null,\r\n \"total\" :300\r\n }\r\n ]\r\n}"},"url":"{{BASE_URL}}/vouchers","description":"Create New Voucher
\nPayload parameters
\n| voucherNumber | \nRequired \n String \n Must be no longer than 50 characters. \n | \n
| memo | \nOptional \n String \n Must be no longer than 100 characters. \n | \n
| date | \nOptional \n String yyyy-mm-dd \n By default it will be voucher creation date, If a date is passed, that will\n override any default. \n | \n
| payeeId | \nRequired \n String \n Must be a payee ID \n | \n
| voucherItems | \nOptional \n Array \n An array of | \n
voucherItems attributes
| invoiceNumber | \nRequired \n String \n Must be no longer than 50 characters. \n | \n
| name | \nOptional \n String \n Must be no longer than 100 characters. \n | \n
| description | \nOptional \n String \n Must be no longer than 100 characters. \n | \n
| quantity | \nOptional \n Integer \n \n | \n
| unitCost | \nOptional \n Decimal \n \n | \n
| total | \nRequired \n Decimal \n \n | \n
Details of an existing voucher. It can be retrieve by passing checkId as well as retrieve directly by passing voucherId.
\nPath parameters
\n| voucherId | \nRequired \n The id of the voucher to be retrieved. \n |
Permanently deletes a voucher.
\nPath parameters
\n| voucherId | \nRequired \n The id of the voucher to be delete. \n |
Update existing voucher details
\nPath parameters
\n| voucherId | \nRequired \n The id of the voucher to be update. \n |
Payload parameters
\n| voucherNumber | \nRequired \n String \n Must be no longer than 50 characters. \n | \n
| memo | \nOptional \n String \n Must be no longer than 100 characters. \n | \n
| date | \nOptional \n String yyyy-mm-dd \n By default it will be current date, If a date is passed, that will\n override any default. \n | \n
| payeeId | \nRequired \n String \n Must be a payee ID \n | \n
| voucherItems | \nOptional \n Array \n An array of | \n
voucherItems attributes
| invoiceNumber | \nRequired \n String \n Must be no longer than 50 characters. \n | \n
| name | \nOptional \n String \n Must be no longer than 100 characters. \n | \n
| description | \nOptional \n String \n Must be no longer than 100 characters. \n | \n
| quantity | \nOptional \n Integer \n \n | \n
| unitCost | \nOptional \n Decimal \n \n | \n
| total | \nRequired \n Decimal \n \n | \n
The API provides endpoints for creating voucher, retrieving individual voucher, deleting voucher, and updated voucher.
\n","_postman_id":"cacd83b8-37b3-4286-81d0-302ad8ed8f47"},{"name":"Direct Deposit/ACH","item":[{"name":"Create Direct Deposit","id":"4fa9d590-4c10-45bc-9fc6-3ae254e8a948","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{AUTH_TOKEN}}"},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{AUTH_TOKEN}} ","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\r\n \"sourceAccount\" : \"rRBQPA4m375qe7gxqXW\",\r\n \"destinationAccount\": {\r\n \"routingNumber\" : \"031176110\",\r\n \"accountNumber\" : \"987654321\",\r\n \"accountType\" : \"CHECKING\" \r\n },\r\n \"payToInfo\" :{\r\n \"name\" :\"TEST RECEIVER\",\r\n \"nickName\" :null,\r\n \"company\" :null,\r\n \"email\" :\"receiver@test.com\",\r\n \"phone\" :null,\r\n \"address1\" :null,\r\n \"address2\" :null,\r\n \"city\" :null,\r\n \"state\" :null,\r\n \"zip\" :null,\r\n \"country\" :null\r\n },\r\n \r\n \"description\" :\"Just test DD \",\r\n \"amount\" :\"1000.00\"\r\n\r\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/directDeposit/create","urlObject":{"path":["directDeposit","create"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"ea11fd72-50a3-4da3-b057-9400cb3a3234","name":"SUCCESS RESPONSE-1","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","type":"text"},{"key":"Authorization","value":"Bearer {{AUTH_TOKEN}} ","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\r\n \"sourceAccount\" : \"BQPA4m375qe7gxq\",\r\n \"destinationAccount\": {\r\n \"routingNumber\" : \"113110612\",\r\n \"accountNumber\" : \"1234567897890\",\r\n \"accountType\" : \"CHECKING\" \r\n },\r\n \"payToInfo\" :{\r\n \"name\" :\"TEST RECEIVER\",\r\n \"nickName\" :null,\r\n \"company\" :null,\r\n \"email\" :\"receiver@test.com\",\r\n \"phone\" :null,\r\n \"address1\" :null,\r\n \"address2\" :null,\r\n \"city\" :null,\r\n \"state\" :null,\r\n \"zip\" :null,\r\n \"country\" :null\r\n },\r\n \r\n \"description\" :\"Just test DD \",\r\n \"amount\" :551.00\r\n\r\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/directDeposit/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8000"},{"key":"Date","value":"Wed, 23 Jun 2021 10:00:04 GMT"},{"key":"Date","value":"Wed, 23 Jun 2021 10:00:04 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.4.13"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"phpdebugbar-id","value":"X6463ac2d7e249d9974aef0f8a7f021bb"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Successfully done\",\n \"data\": {\n \"checkId\": \"dN03WlEkLbpOw6YmZjqnmzw45MXrx19aJvRy8APq\",\n \"amount\": 551,\n \"payeeName\": \"TEST RECEIVER\",\n \"destinationAccount\": {\n \"routingNumber\": \"113110612\",\n \"accountNumber\": \"1234567897890\",\n \"accountType\": \"CHECKING\"\n }\n }\n}"},{"id":"7388806f-f971-4b29-99cb-55ece63ea3a1","name":"SUCCESS RESPONSE- 2 (Using payeeId)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{AUTH_TOKEN}} ","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\r\n \"sourceAccount\" : \"BQPA4m375qe7gxq\",\r\n \"payeeId\" :\"X0Kmz47R6jLOM27\",\r\n \"destinationAccount\": {\r\n \"routingNumber\" : \"113110612\",\r\n \"accountNumber\" : \"1234567897890\",\r\n \"accountType\" : \"CHECKING\" \r\n },\r\n \r\n \"description\" :\"Just test DD \",\r\n \"amount\" :551.00\r\n\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/directDeposit/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8000"},{"key":"Date","value":"Wed, 23 Jun 2021 10:00:04 GMT"},{"key":"Date","value":"Wed, 23 Jun 2021 10:00:04 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.4.13"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"phpdebugbar-id","value":"X6463ac2d7e249d9974aef0f8a7f021bb"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Successfully done\",\n \"data\": {\n \"checkId\": \"dN03WlEkLbpOw6YmZjqnmzw45MXrx19aJvRy8APq\",\n \"amount\": 551,\n \"payeeName\": \"TEST RECEIVER\",\n \"destinationAccount\": {\n \"routingNumber\": \"113110612\",\n \"accountNumber\": \"1234567897890\",\n \"accountType\": \"CHECKING\"\n }\n }\n}"},{"id":"adb8a669-5b0a-4af5-8206-44b369d7c1ac","name":"ERROR RESPONSE 1","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","type":"text"},{"key":"Authorization","value":"Bearer {{AUTH_TOKEN}} ","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\r\n \"sourceAccount\" : \"BQPA4m375qe7gxq\",\r\n \"destinationAccount\": {\r\n \"routingNumber\" : \"1131106120\",\r\n \"accountNumber\" : \"1234567897890\",\r\n \"accountType\" : \"CHECKING\" \r\n },\r\n \"payToInfo\" :{\r\n \"name\" :\"TEST RECEIVER\",\r\n \"nickName\" :null,\r\n \"company\" :null,\r\n \"email\" :\"receiver@test.com\",\r\n \"phone\" :null,\r\n \"address1\" :null,\r\n \"address2\" :null,\r\n \"city\" :null,\r\n \"state\" :null,\r\n \"zip\" :null,\r\n \"country\" :null\r\n },\r\n \r\n \"description\" :\"Just test DD \",\r\n \"amount\" :551.00\r\n\r\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/directDeposit/create"},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8000"},{"key":"Date","value":"Wed, 23 Jun 2021 10:00:40 GMT"},{"key":"Date","value":"Wed, 23 Jun 2021 10:00:40 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.4.13"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"phpdebugbar-id","value":"X9151b40fe100c87800b28099ad835b2c"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"errorMsg\": \"Invalid destination routing number\"\n}"},{"id":"5aad774a-ccf2-4395-be73-c18f51e46f71","name":"ERROR RESPONSE 2","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","type":"text"},{"key":"Authorization","value":"Bearer {{AUTH_TOKEN}} ","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\r\n \"sourceAccount\" : \"BQPA4m375qe7gxq\",\r\n \"destinationAccount\": {\r\n \"routingNumber\" : \"113110612\",\r\n \"accountNumber\" : \"1234567897890\",\r\n \"accountType\" : \"CHECKING\" \r\n },\r\n \"payToInfo\" :{\r\n \"name\" :\"TEST RECEIVER\",\r\n \"nickName\" :null,\r\n \"company\" :null,\r\n \"email\" :null,\r\n \"phone\" :null,\r\n \"address1\" :null,\r\n \"address2\" :null,\r\n \"city\" :null,\r\n \"state\" :null,\r\n \"zip\" :null,\r\n \"country\" :null\r\n },\r\n \r\n \"description\" :\"Just test DD \",\r\n \"amount\" :551.00\r\n\r\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/directDeposit/create"},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8000"},{"key":"Date","value":"Wed, 23 Jun 2021 10:01:27 GMT"},{"key":"Date","value":"Wed, 23 Jun 2021 10:01:27 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.4.13"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"phpdebugbar-id","value":"X35722280d27fc31eb931a486e7d564fe"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"errorMsg\": \"The payee email must be a valid email address.\"\n}"},{"id":"ad4dca1a-cc4f-4787-8e34-50d6306f244d","name":"ERROR RESPONSE 3","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","type":"text"},{"key":"Authorization","value":"Bearer {{AUTH_TOKEN}} ","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\r\n \"sourceAccount\" : \"BQPA4m375qe7gxq8\",\r\n \"destinationAccount\": {\r\n \"routingNumber\" : \"113110612\",\r\n \"accountNumber\" : \"1234567897890\",\r\n \"accountType\" : \"CHECKING\" \r\n },\r\n \"payToInfo\" :{\r\n \"name\" :\"TEST RECEIVER\",\r\n \"nickName\" :null,\r\n \"company\" :null,\r\n \"email\" :\"receiver@test.com\",\r\n \"phone\" :null,\r\n \"address1\" :null,\r\n \"address2\" :null,\r\n \"city\" :null,\r\n \"state\" :null,\r\n \"zip\" :null,\r\n \"country\" :null\r\n },\r\n \r\n \"description\" :\"Just test DD \",\r\n \"amount\" :551.00\r\n\r\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/directDeposit/create"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8000"},{"key":"Date","value":"Wed, 23 Jun 2021 10:03:39 GMT"},{"key":"Date","value":"Wed, 23 Jun 2021 10:03:39 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.4.13"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"phpdebugbar-id","value":"Xba1041f977aacca802fc6be39bf16911"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"errorMsg\": \"This source bank account not found\"\n}"}],"_postman_id":"4fa9d590-4c10-45bc-9fc6-3ae254e8a948"},{"name":"Get Status","id":"861f8d35-eb32-47a0-8d39-e7b687ea46d4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{AUTH_TOKEN}}"},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{AUTH_TOKEN}} ","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{BASE_URL}}/ach/{checkId}/status","urlObject":{"path":["ach","{checkId}","status"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"7340da52-ebbc-4265-930b-007ea4504371","name":"Get Status","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{AUTH_TOKEN}} ","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{BASE_URL}}/ach/w2lx48K3LVjMzWy/status"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8000"},{"key":"Date","value":"Thu, 15 Jul 2021 08:23:13 GMT"},{"key":"Date","value":"Thu, 15 Jul 2021 08:23:13 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.4.13"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"200"},{"key":"X-RateLimit-Remaining","value":"198"},{"key":"phpdebugbar-id","value":"X545638274b1535adbcd214027139d134"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"checkId\": \"w2lx48K3LVjMzWy\",\n \"status\": 400,\n \"description\": \"DD\"\n }\n}"}],"_postman_id":"861f8d35-eb32-47a0-8d39-e7b687ea46d4"},{"name":"Get All status","id":"37df9d2c-47dd-41f4-ba60-713f40d766aa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{AUTH_TOKEN}}"},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{AUTH_TOKEN}} ","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{BASE_URL}}/ach/{checkId}/statusAll","urlObject":{"path":["ach","{checkId}","statusAll"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"f07ef3d0-0709-4be8-8bd9-95589d397a9f","name":"Get All status","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{AUTH_TOKEN}} ","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{BASE_URL}}/ach/w2lx48K3LVjMzWy/statusAll"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8000"},{"key":"Date","value":"Thu, 15 Jul 2021 07:47:32 GMT"},{"key":"Date","value":"Thu, 15 Jul 2021 07:47:32 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.4.13"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"200"},{"key":"X-RateLimit-Remaining","value":"199"},{"key":"phpdebugbar-id","value":"Xf1a43354caaaca057cbe7c089d16289d"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": \"w2lx48K3LVjMzWy\",\n \"status\": [\n {\n \"status\": \"DD\",\n \"created_at\": \"2021-07-15 07:31:06\"\n },\n {\n \"status\": \"created\",\n \"created_at\": \"2021-07-14 09:32:43\"\n }\n ]\n }\n}"}],"_postman_id":"37df9d2c-47dd-41f4-ba60-713f40d766aa"}],"id":"f222d701-797f-4082-bf20-e04cf565d4f4","description":"Direct Deposit/ACH Payment may not work unless we manually approve your account. Please talk to our technical support team to enable it for you.
\nDIRECT DEPOSIT STATUS
\n| Status | Description | Meaning |
|---|---|---|
| 400 | DD | Direct Deposit Initiated |
| 410 | DD-FUNDING | Funding started |
| 411 | DD | Funding completed |
| 412 | DD Failed | DD Funding Failed PF |
| 420 | DDC | DD Completed/Credited receiver wallet |
| 430 | DD-DEPOSITING | Depositing started |
| 431 | DDC | Direct deposit completed |
| 432 | DD-DEPOSIT-F | Direct deposit failed |
| 433 | DD-BA-NOT-VERIFIED | Bank account verification required for depositing |
| 440 | DD/F | Direct Deposit Failed |
| 441 | DDR | DD returned(deposit) |
To enable this featuer talk with our customer support team. Here is the documenation : https://documenter.getpostman.com/view/8364227/Tzeak6dq
\n","event":[{"listen":"prerequest","script":{"id":"1cd9f7a8-f486-4865-9223-665ecbe409be","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"fe6d34c8-1048-49f6-a8c6-b56abb89acd6","type":"text/javascript","exec":[""]}}],"_postman_id":"f222d701-797f-4082-bf20-e04cf565d4f4"},{"name":"Send Payment","item":[{"name":"ACH","item":[{"name":"Send ACH Payment","id":"62c06e9b-76e2-4158-8841-eaa2ef6ef1a8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{AUTH_TOKEN}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"\r\n{\r\n \"sourceType\": \"bankAccount\",\r\n \"sourceId\": \"BQPA4m375qe7gxq\",\r\n \"amount\":\"2.23\",\r\n \"description\":\"payment #123\",\r\n \"payeeId\":\"903wmjY5Yj71bkv\",\r\n \"payeeBankAccount\":\"qRmA345z6GgdoLl\",\r\n \"referenceNo\":\"12312\"\r\n}\r\n ","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/send-payment/ach","description":"Initiate an ACH Payment from a wallet or bank account.
Allowed sourceType : wallet , bankAccount
Get all the ACH payments you have initiated.
\nQuery parameters
\nreferenceNo | Filter records by referenceNo |
ACH Payment may not work unless we manually approve your account. Please talk to our technical support team to enable it for you.
\n","_postman_id":"d8f3619c-6079-44ef-b1cf-8dff854d6a06"},{"name":"Wire","item":[{"name":"Send Wire Payment","id":"8c055313-dbcc-4966-bad6-54aa7384c883","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{AUTH_TOKEN}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"\r\n{\r\n \"sourceType\": \"wallet\",\r\n \"sourceId\": \"e9633880-6b23-466f-87bb-93832d38191c\",\r\n \"amount\":\"2.00\",\r\n \"description\":\"v3 pay 1\",\r\n \"payeeId\":\"36gYVewEo4dx7bD\",\r\n \"payeeBankAccount\":\"JB1y3GLWp4pX8z6\",\r\n \"referenceNo\":\"12312\"\r\n}\r\n ","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/send-payment/wire","description":"Initiate an Wire Payment from a wallet or bank account.
Allowed sourceType : wallet ,bankAccount
Get all the Wire payments you have initiated.
\nQuery parameters
\nreferenceNo | Filter records by referenceNo |
Wire Payment may not work unless we manually approve your account. Please talk to our technical support team to enable it for you.
\n","_postman_id":"f322a4a7-3bdc-471d-8756-b86e8af2f8f1"},{"name":"Instant Transfer/RTP","item":[{"name":"Send Instant Payment/RTP","id":"dcf83ffc-e0db-4dbe-95a7-68d075a3ddb4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{AUTH_TOKEN}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"\r\n{\r\n \"sourceType\": \"wallet\",\r\n \"sourceId\": \"e9633880-6b23-466f-87bb-93832d38191c\",\r\n \"amount\":\"2.00\",\r\n \"description\":\"RTP Payment\",\r\n \"payeeId\":\"36gYVewEo4dx7bD\",\r\n \"payeeBankAccount\":\"JB1y3GLWp4pX8z6\",\r\n \"referenceNo\":\"12312\"\r\n}\r\n ","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/send-payment/instant_transfer","urlObject":{"path":["send-payment","instant_transfer"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"ebe65c13-821b-4e1c-b66a-e2a6b18242a1","name":"Send Wire Payment from Wallet","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{AUTH_TOKEN}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"\r\n{\r\n \"sourceType\": \"wallet\",\r\n \"sourceId\": \"e9633880-6b23-466f-87bb-93832d38191c\",\r\n \"amount\":\"2.00\",\r\n \"description\":\"RTP Payment\",\r\n \"payeeId\":\"36gYVewEo4dx7bD\",\r\n \"payeeBankAccount\":\"JB1y3GLWp4pX8z6\",\r\n \"referenceNo\":\"12312\"\r\n}\r\n ","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/send-payment/instant_transfer"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8000"},{"key":"Date","value":"Sun, 25 Aug 2024 07:32:16 GMT"},{"key":"Date","value":"Sun, 25 Aug 2024 07:32:16 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.4.13"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"phpdebugbar-id","value":"X618fe1994f52ee76f0937abd29122adc"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": \"d14a2933-bdc0-4527-b719-2f12d1f23bf3\",\n \"amount\": \"2.00\",\n \"payeeId\": \"36gYVewEo4dx7bD\",\n \"transferType\": \"RTP\",\n \"referenceNo\": \"12312\",\n \"status\": \"PROCESSING\",\n \"description\": \"v3 pay 1\",\n \"source\": {\n \"sourceType\": \"wallet\",\n \"sourceId\": \"e9633880-6b23-466f-87bb-93832d38191c\"\n },\n \"virtualCard\": null,\n \"wire\": null,\n \"instant_transfer\": {\n \"beneficiary\": {\n \"name\": \"GolbalTech Solution \",\n \"account_number\": \"123456789\",\n \"routing_number\": \"113103276\",\n \"account_type\": \"CHECKING\",\n \"address1\": \"1234 East Elm Street\",\n \"address2\": \"\",\n \"city\": \"Springfield\",\n \"state\": \"MO\",\n \"zip\": \"65802\",\n \"country\": \"US\"\n }\n },\n \"ach\": null,\n \"createdAt\": \"2024-08-25T07:32:15.000000Z\",\n \"updatedAt\": \"2024-08-25T07:32:15.000000Z\"\n }\n}"}],"_postman_id":"dcf83ffc-e0db-4dbe-95a7-68d075a3ddb4"},{"name":"List All Instant Payments","id":"97629a05-7da2-4cac-9178-86c34203b585","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{AUTH_TOKEN}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"{{BASE_URL}}/send-payment/instant_transfer","description":"Get all the Wire payments you have initiated.
\nQuery parameters
\nreferenceNo | Filter records by referenceNo |
RTP Payment may not work unless we manually approve your account. Please talk to our technical support team to enable it for you.
\n","_postman_id":"bc495a6f-7312-4cce-a00b-4221d670b5a7"},{"name":"Virtual Card","item":[{"name":"Send Virtual Card","id":"45c6c35b-c627-4cf4-9ef7-3e5b64ef4a96","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{AUTH_TOKEN}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"\r\n{\r\n \"sourceType\": \"wallet\",\r\n \"sourceId\": \"e9633880-6b23-466f-87bb-93832d38191c\",\r\n \"amount\":\"10.00\",\r\n \"description\":\"VC to GolbalTech\",\r\n \"payeeId\":\"36gYVewEo4dx7bD\", \r\n \"referenceNo\":\"12312\"\r\n}\r\n ","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/send-payment/virtualCard","description":"Send a Virtual Card to your payee.
Allowed sourceType : wallet , bankAccount
Get all the Virtual Cards you have sent.
\nQuery parameters
\nreferenceNo | Filter records by referenceNo |
Send Virtual Card API may not work unless we manually approve your account. Please talk to our technical support team to enable it for you.
\n","_postman_id":"5cd89638-be10-4037-9746-00ee0ca0434e"},{"name":"Check Mail","item":[{"name":"Attachments","item":[{"name":"Add Attachment","id":"0d91c9db-838a-40e9-a757-d3678602ccc9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"image","type":"file","uuid":"34d3f79b-e751-47cd-bf18-87e983dc4d39","src":"JvrRi4PP0/Sample PDF.pdf"},{"key":"fileUrl","value":"https://pdfobject.com/pdf/sample.pdf","type":"text","uuid":"f7ab5829-6a1e-4e8c-bbe0-92737465ea9b"}]},"url":"{{BASE_URL}}/attachment","description":"This API uploads an attachment file (example: PDF,document) and returns a unique attachment ID.
\nSupported File Types
\n","urlObject":{"path":["attachment"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"0a384141-839a-48b5-97db-aa126fab530f","name":"Add Attachments","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{vault:bearer-token}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"image","type":"file","uuid":"d801c17a-8a85-47be-bb5d-2adf8fcf9d1b","src":"kDnWp8Gfp/Sample PDF.pdf"},{"key":"fileUrl","value":"https://pdfobject.com/pdf/sample.pdf","type":"text","uuid":"a3c5f80d-8881-4a97-8532-751da178f7d8"}],"options":{"raw":{"language":"json"}}},"url":"http://localhost:8000/api/v3/send-payment/wire"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8000"},{"key":"Date","value":"Sun, 25 Aug 2024 06:55:25 GMT"},{"key":"Date","value":"Sun, 25 Aug 2024 06:55:25 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.4.13"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"phpdebugbar-id","value":"X79ef8e985b5fa2377920b0bf8f8655b2"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": \"OYxZqXGKdeRzVvJ\"\n }\n}"}],"_postman_id":"0d91c9db-838a-40e9-a757-d3678602ccc9"},{"name":"View Attachment","id":"fc563c51-0f26-496c-b7e5-ae7d80c7c9d8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{BASE_URL}}/attachment/{attachment_id}","description":"This API retrieves the uploaded attachment using the provided attachment_id and returns a secure pre-signed URL to view or download the file.
This API deletes an uploaded attachment using the provided attachment_id.Once deleted, the file cannot be accessed or retrieved again.
This API endpoint allows you to initiate a check mailing payment directly from a specified wallet.
\nPayload Parameter
\nAvailable Shipping Types
\n","urlObject":{"path":["send-payment","checkMail"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"d971d964-9a1f-4264-962b-6b237ba7340d","name":"Send Check Mail Payment from Wallet","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{AUTH_TOKEN}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"sourceType\": \"wallet\",\r\n \"sourceId\": \"7ed806cf-7ccb-4aa2-9ae8-d1118f2f048b\",\r\n \"amount\": \"55.00\",\r\n \"description\": \"VC to GolbalTech\",\r\n \"payeeId\": \"9MqkGWLnKveD7Ry\",\r\n \"referenceNo\": \"1234\",\r\n \"shippingType\": \"USPS_PRIORITY_MAIL\",\r\n \"attachmentIds\": [\"B8pJReao3m4W51E\"]\r\n} ","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/send-payment/checkMail"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8000"},{"key":"Date","value":"Sun, 25 Aug 2024 07:32:16 GMT"},{"key":"Date","value":"Sun, 25 Aug 2024 07:32:16 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.4.13"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"phpdebugbar-id","value":"X618fe1994f52ee76f0937abd29122adc"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": \"bf3f8335-405c-4ea5-8cca-0e2063869408\",\n \"amount\": \"55.00\",\n \"payeeId\": \"9MqkGWLnKveD7Ry\",\n \"transferType\": \"checkMail\",\n \"referenceNo\": \"1234\",\n \"status\": \"PROCESSING\",\n \"description\": \"VC to GolbalTech\",\n \"source\": {\n \"sourceType\": \"wallet\",\n \"sourceId\": \"7ed806cf-7ccb-4aa2-9ae8-d1118f2f048b\"\n },\n \"clearingFile\": null,\n \"previewFile\": null,\n \"virtualCard\": null,\n \"wire\": null,\n \"ach\": null,\n \"instant_transfer\": null,\n \"createdAt\": \"2025-05-19T08:59:01.000000Z\",\n \"updatedAt\": \"2025-05-19T08:59:01.000000Z\"\n }\n}"}],"_postman_id":"37bcd406-9351-49eb-b45b-bfdf4f05dc16"},{"name":"List All Check Mail Payments","id":"fce9b0b4-9225-4d87-89be-722f70de3c94","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{AUTH_TOKEN}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"{{BASE_URL}}/send-payment/checkMail","description":"Get all the Check Mail payments you have initiated.
\n","urlObject":{"path":["send-payment","checkMail"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"1072eb85-b241-4136-b420-a632c69a55fc","name":"List All Check Mail Payments","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{vault:bearer-token}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"{{BASE_URL}}/send-payment/checkMail"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8000"},{"key":"Date","value":"Sun, 25 Aug 2024 06:56:16 GMT"},{"key":"Date","value":"Sun, 25 Aug 2024 06:56:16 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.4.13"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"58"},{"key":"phpdebugbar-id","value":"X7225ad045607e16d9ff521836fdba2bd"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"meta\": {\n \"total\": 2,\n \"perPage\": 10,\n \"currentPage\": 1,\n \"lastPage\": 1\n },\n \"data\": [\n {\n \"id\": \"bf3f8335-405c-4ea5-8cca-0e2063869408\",\n \"amount\": \"55.00\",\n \"payeeId\": \"9MqkGWLnKveD7Ry\",\n \"transferType\": \"checkMail\",\n \"referenceNo\": \"1234\",\n \"status\": \"PROCESSING\",\n \"description\": \"VC to GolbalTech\",\n \"source\": {\n \"sourceType\": \"wallet\",\n \"sourceId\": \"7ed806cf-7ccb-4aa2-9ae8-d1118f2f048b\"\n },\n \"clearingFile\": null,\n \"previewFile\": null,\n \"createdAt\": \"2025-05-19T08:59:01.000000Z\",\n \"updatedAt\": \"2025-05-19T08:59:01.000000Z\"\n },\n {\n \"id\": \"6eba569f-6438-479d-89dd-3c4f0304132c\",\n \"amount\": \"20.00\",\n \"payeeId\": \"9MqkGWLnKveD7Ry\",\n \"transferType\": \"checkMail\",\n \"referenceNo\": \"1234\",\n \"status\": \"PROCESSING\",\n \"description\": \"VC to GolbalTech\",\n \"source\": {\n \"sourceType\": \"wallet\",\n \"sourceId\": \"7ed806cf-7ccb-4aa2-9ae8-d1118f2f048b\"\n },\n \"clearingFile\": null,\n \"previewFile\": null,\n \"createdAt\": \"2025-05-19T07:23:02.000000Z\",\n \"updatedAt\": \"2025-05-19T07:23:03.000000Z\"\n }\n ]\n}"}],"_postman_id":"fce9b0b4-9225-4d87-89be-722f70de3c94"}],"id":"6b781f72-bba4-4a6e-a872-c95373784d60","description":"Check mailing payments may not work until your account is manually approved. Please contact our technical support team to enable this feature. Also, ensure your business verification is completed before processing any check mailing payments.
\n","_postman_id":"6b781f72-bba4-4a6e-a872-c95373784d60"},{"name":"Retrieve Payment Info","id":"401d4b6a-b33f-4604-a1c6-7dc966ac389b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{AUTH_TOKEN}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"{{BASE_URL}}/send-payment/{{paymentId}}/info","description":"You can retrieve the payment status by passing the payment ID.
\nPAYMENT STATUS
\n","urlObject":{"path":["send-payment","{{paymentId}}","info"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"951d5d52-e02e-4cea-9237-44aac9a734f3","name":"Retrieve Payment Info -Wire","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{vault:bearer-token}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"http://localhost:8000/api/v3/send-payment/26d94501-04ad-40f8-9ce4-03624fd0fbf2/info"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8000"},{"key":"Date","value":"Sun, 25 Aug 2024 06:50:12 GMT"},{"key":"Date","value":"Sun, 25 Aug 2024 06:50:12 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.4.13"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"phpdebugbar-id","value":"X6edfc52b768bb417933b8fdd5ba42c18"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": \"26d94501-04ad-40f8-9ce4-03624fd0fbf2\",\n \"amount\": \"1.25\",\n \"payeeId\": \"36gYVewEo4dx7bD\",\n \"transferType\": \"wire\",\n \"referenceNo\": \"\",\n \"status\": \"PROCESSING\",\n \"description\": \"Payroll\",\n \"source\": {\n \"sourceType\": \"bankAccount\",\n \"sourceId\": \"rRBQPA4m375qe7gxqXW\"\n },\n \"virtualCard\": null,\n \"wire\": {\n \"imad\": \"\",\n \"beneficiary\": {\n \"name\": \"GolbalTech Solution \",\n \"account_number\": \"123456789\",\n \"routing_number\": \"113103276\",\n \"account_type\": \"CHECKING\",\n \"address1\": \"1234 East Elm Street\",\n \"address2\": \"\",\n \"city\": \"Springfield\",\n \"state\": \"MO\",\n \"zip\": \"65802\",\n \"country\": \"US\"\n }\n },\n \"ach\": null,\n \"createdAt\": \"2024-08-25T06:45:56.000000Z\",\n \"updatedAt\": \"2024-08-25T06:46:08.000000Z\"\n }\n}"},{"id":"8dbcc01e-18c6-4c59-a209-9904ab6edb6f","name":"Retrieve Payment Info-ACH","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{AUTH_TOKEN}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"{{BASE_URL}}/send-payment/6091bee3-9c16-449f-a7ff-7478db0754ce/info"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8000"},{"key":"Date","value":"Sun, 25 Aug 2024 07:24:44 GMT"},{"key":"Date","value":"Sun, 25 Aug 2024 07:24:44 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.4.13"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"phpdebugbar-id","value":"X1dfaf6b30082f57edafecde7d1dd0458"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": \"6091bee3-9c16-449f-a7ff-7478db0754ce\",\n \"amount\": \"2.50\",\n \"payeeId\": \"36gYVewEo4dx7bD\",\n \"transferType\": \"ach\",\n \"referenceNo\": \"12313\",\n \"status\": \"PROCESSING\",\n \"description\": \"v3 pay 1\",\n \"source\": {\n \"sourceType\": \"bankAccount\",\n \"sourceId\": \"rRBQPA4m375qe7gxqXW\"\n },\n \"virtualCard\": null,\n \"wire\": null,\n \"ach\": {\n \"name\": \"GlobalTech Solutions\",\n \"account_number\": \"123456789\",\n \"routing_number\": \"113103276\",\n \"ach_trace_number\": null\n },\n \"createdAt\": \"2024-08-25T06:58:34.000000Z\",\n \"updatedAt\": \"2024-08-25T06:58:35.000000Z\"\n }\n}"},{"id":"c1e4fc66-3ec8-4b5b-88fb-770a89fe6f73","name":"Retrieve Payment Info-Virtual Card","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{AUTH_TOKEN}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"{{BASE_URL}}/send-payment/4cf53720-8f89-4b95-9a70-2ff58b351108/info"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8000"},{"key":"Date","value":"Sun, 25 Aug 2024 07:25:13 GMT"},{"key":"Date","value":"Sun, 25 Aug 2024 07:25:13 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.4.13"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"58"},{"key":"phpdebugbar-id","value":"Xc5b87c4ed1731eba23b17e909d4a21bd"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": \"4cf53720-8f89-4b95-9a70-2ff58b351108\",\n \"amount\": \"10.00\",\n \"payeeId\": \"36gYVewEo4dx7bD\",\n \"transferType\": \"virtualCard\",\n \"referenceNo\": \"12312\",\n \"status\": \"PROCESSING\",\n \"description\": \"VC to GolbalTech\",\n \"source\": {\n \"sourceType\": \"bankAccount\",\n \"sourceId\": \"rRBQPA4m375qe7gxqXW\"\n },\n \"virtualCard\": {\n \"card_holder\": {\n \"name\": \"GlobalTech Solutions\",\n \"email\": \"globaltechsolution@test.com\",\n \"phone\": null,\n \"address1\": null,\n \"address2\": \"\",\n \"city\": null,\n \"state\": null,\n \"zip\": null,\n \"country\": null\n }\n },\n \"wire\": null,\n \"ach\": null,\n \"createdAt\": \"2024-08-25T07:23:24.000000Z\",\n \"updatedAt\": \"2024-08-25T07:23:24.000000Z\"\n }\n}"},{"id":"c8cccec8-2599-45f9-9388-41a416400b9c","name":"Retrieve Payment Info-Check Mail","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{AUTH_TOKEN}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"{{BASE_URL}}/send-payment/290df7d2-d2e5-468b-8671-1cad4443ddf7/info"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8000"},{"key":"Date","value":"Sun, 25 Aug 2024 07:25:13 GMT"},{"key":"Date","value":"Sun, 25 Aug 2024 07:25:13 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.4.13"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"58"},{"key":"phpdebugbar-id","value":"Xc5b87c4ed1731eba23b17e909d4a21bd"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": \"290df7d2-d2e5-468b-8671-1cad4443ddf7\",\n \"amount\": \"35.00\",\n \"payeeId\": \"9MqkGWLnKveD7Ry\",\n \"transferType\": \"checkMail\",\n \"referenceNo\": \"1234\",\n \"status\": \"COMPLETED\",\n \"description\": \"VC to GolbalTech\",\n \"source\": {\n \"sourceType\": \"wallet\",\n \"sourceId\": \"7ed806cf-7ccb-4aa2-9ae8-d1118f2f048b\"\n },\n \"clearingFile\": \"https://ocw-local-s3.s3.amazonaws.com/checkmail/clearing/clearing-334--1747645038.png?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=%7B%7Bvault:aws-access-key%7D%7D%2F20250519%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20250519T132939Z&X-Amz-SignedHeaders=host&X-Amz-Expires=600&X-Amz-Signature=65695fe321ad5e8ee130578838077b26480ae57bd38f87d31f96176735a616dd\",\n \"previewFile\": \"https://ocw-local-s3.s3.amazonaws.com/checkmail/preview/preview-334--1747644941.pdf?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=%7B%7Bvault:aws-access-key%7D%7D%2F20250519%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20250519T132939Z&X-Amz-SignedHeaders=host&X-Amz-Expires=600&X-Amz-Signature=4b9be58599c2cb5f0413611aced2903311215143c7aace96684b1dc6b863de81\",\n \"tracking\": {\n \"carrier\": \"USPS\",\n \"trackingCode\": \"EZ4000000004\",\n \"status\": \"\",\n \"estimatedDeliveryDate\": \"\",\n \"trackingUrl\": \"https://tools.usps.com/go/TrackConfirmAction?tLabels=EZ4000000004\",\n \"trackingDetails\": []\n },\n \"virtualCard\": null,\n \"wire\": null,\n \"ach\": null,\n \"instant_transfer\": null,\n \"createdAt\": \"2025-05-19T08:52:36.000000Z\",\n \"updatedAt\": \"2025-05-19T08:55:16.000000Z\"\n }\n}\n"}],"_postman_id":"401d4b6a-b33f-4604-a1c6-7dc966ac389b"}],"id":"7eb798aa-2bb3-4e85-bf60-2a478ae90d4c","_postman_id":"7eb798aa-2bb3-4e85-bf60-2a478ae90d4c","description":""},{"name":"Receive Payment","item":[{"name":"Payment Link","item":[{"name":"Create Payment Link","id":"4e5891bd-269f-43ef-a9ee-834f0f46ad0f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"Create Payment link.
\n","urlObject":{"path":["getpaid-by-form",""],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"a0dc0e34-66c7-44ea-8caa-d2e8b8a7a942","name":"Create Payment Link","originalRequest":{"method":"POST","header":[],"url":{"raw":"{{BASE_URL}}/getpaid-by-form/?Accept=application/json","host":["{{BASE_URL}}"],"path":["getpaid-by-form",""],"query":[{"key":"Accept","value":"application/json"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"127.0.0.1:8000"},{"key":"Date","value":"Thu, 01 Jul 2021 06:52:10 GMT"},{"key":"Date","value":"Thu, 01 Jul 2021 06:52:10 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.4.13"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"linkId\": \"y3n1ZoVelEBj8pwba62\",\n \"shortUrl\": \"createlink\",\n \"createdAt\": \"2022-09-16T13:13:16.000000Z\" ,\n \"paymentLink\": \"https://paybycheck.io/createlink\"\n }\n}"}],"_postman_id":"4e5891bd-269f-43ef-a9ee-834f0f46ad0f"},{"name":"Get Payment Link","id":"30ed53b8-0a16-4605-811e-4d9928683b62","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{AUTH_TOKEN}}"},"isInherited":false},"method":"GET","header":[],"url":"{{BASE_URL}}/getpaid-by-form/","urlObject":{"path":["getpaid-by-form",""],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"d94ed902-668a-4eb1-8723-c9cbd0ca79a2","name":"Get All short Url","originalRequest":{"method":"GET","header":[],"url":"{{BASE_URL}}/getpaid-by-form/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"127.0.0.1:8000"},{"key":"Date","value":"Thu, 01 Jul 2021 06:52:10 GMT"},{"key":"Date","value":"Thu, 01 Jul 2021 06:52:10 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.4.13"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": \"l3B8pJReapmGW51EoDN\",\n \"name\": \"short-url-demo\",\n \"bankAccountId\": \"Ow6YmZjqDJoJe5MXrx1\",\n \"short_url\": \"short-url-demo\",\n \"bottom_text\": \"Test Text\",\n \"created_at\": \"2021-07-01T06:49:28.000000Z\",\n \"paymentLink\": \"https://paybycheck.io/short-url-demo\"\n },\n {\n \"id\": \"pOw6YmZjq2A45MXrx19\",\n \"name\": \"payment-url-demo\",\n \"bankAccountId\": \"yx5qvgjD5dnr40mYNPD\",\n \"short_url\": \"payment-url-demo\",\n \"bottom_text\": null,\n \"created_at\": \"2021-07-01T06:52:02.000000Z\",\n \"paymentLink\": \"https://paybycheck.io/payment-url-demo\"\n }\n ]\n}"}],"_postman_id":"30ed53b8-0a16-4605-811e-4d9928683b62"},{"name":"Create Payment","id":"40d5ccdf-335e-4995-89f2-c6a51ec9066f","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"accept":true}},"request":{"auth":{"type":"bearer","bearer":{"token":"{{AUTH_TOKEN}}","password":"{{AUTH_TOKEN}}"},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"linkId\" :\"y3n1ZoVelEBj8pwba62\", \r\n \"amount\" : \"1000.00\",\r\n \"paymentType\" :\"onetime\",\r\n \"customField1\":\"1234\",\r\n \"customField2\":\"54545\",\r\n \"customField3\":\"54545\",\r\n \"metaData\":{\r\n \"orderId\":\"65465465\",\r\n \"invoiceNo\":\"5465465\" \r\n },\r\n \r\n \"recurring\" :{\r\n \"frequency\" :\"MONTHLY\",\r\n \"repeatFor\" : \"5\" ,\r\n \"startingDate\":\"2021-07-20\" \r\n }, \r\n \"memo\":\"From API\", \r\n \"customerId\" :\"5bfec490-dd54-482b-82a8-a52034c4c82c\", \r\n \"bankAccountId\" :\"733098e7-6219-4432-8ab4-23c1a423a139\", \r\n \"bankingInfo\":{\r\n \"accountName\":\"Alison Gambala KR\",\r\n \"routingNumber\":\"121000358\",\r\n \"accountNumber\":\"12365478954\"\r\n \r\n },\r\n \"customerDetails\":{\r\n \"customerName\":\"Alison Gambala KR\",\r\n \"customerAdderessLine1\":\"95113 mark street rod\",\r\n \"customerEmail\":\"email@test.com\",\r\n \"customerPhone\":\"900244400\",\r\n \"customerCity\":\"Sanjose\",\r\n \"customerState\":\"CA\",\r\n \"customerZip\":\"95113\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/getpaid-by-form/check/","description":"You can initiate direct deposit using referenceId
EndFragment
\n","urlObject":{"path":["getpaid-by-form","check",""],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"0998c2cc-ba03-489e-88c6-c49d2434b023","name":"create check","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"linkId\" :\"n1ZoVelEBj8pwba\",\r\n \"bankAccountId\":\"yd6LeMYmdQeE8DxEr2s\",\r\n \"shortUrl\":\"short-url\",\r\n \"amount\" : \"1000.00\",\r\n \"paymentType\":\"recurring\",\r\n \r\n \"recurring\" :{\r\n \"frequency\" :\"MONTHLY\",\r\n \"repeatFor\" : \"5\" ,\r\n \"startingDate\":\"2021-07-20\" \r\n }, \r\n \"memo\":\"From API\", \r\n \"bankingInfo\":{\r\n \"accountName\":\"Alison Gambala KR\",\r\n \"routingNumber\":\"121000358\",\r\n \"accountNumber\":\"12365478954\"\r\n \r\n },\r\n \"customerDetails\":{\r\n \"customerName\":\"Alison Gambala KR\",\r\n \"customerAdderessLine1\":\"95113 mark street rod\",\r\n \"customerEmail\":\"email@test.com\",\r\n \"customerPhone\":\"900244400\",\r\n \"customerCity\":\"Sanjose\",\r\n \"customerState\":\"CA\",\r\n \"customerZip\":\"95113\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/getpaid-by-form/check/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"127.0.0.1:8000"},{"key":"Date","value":"Thu, 01 Jul 2021 06:44:17 GMT"},{"key":"Date","value":"Thu, 01 Jul 2021 06:44:17 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.4.13"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"58"},{"key":"phpdebugbar-id","value":"X6b0ba5e6efcb58b5335d6ffb63dfeec7"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"referenceId\": \"zbyd7ON4oV3jng5o0ap\",\n \"data\": {\n \"referenceId\": \"zbyd7ON4oV3jng5o0ap\",\n \"memo\": \"From API\",\n \"amount\": \"1000.00\",\n \"serialNumber\": 1005,\n \"createdAt\": \"2024-12-25T12:10:26.000000Z\",\n \"invoiceNumber\": \"\",\n \"transactionId\": \"\",\n \"customerDetails\": {\n \"customerEmail\": \"email@test.com\",\n \"customerName\": \"customer Name\",\n \"customerAddressLine1\": \"95113 mark street rod\",\n \"customerPhone\": \"123456789\",\n \"customerCity\": \"Sanjose\",\n \"customerState\": \"CA\",\n \"customerZip\": \"\"\n },\n \"metaData\": {\n \"orderId\": \"65465465\",\n \"invoiceNo\": \"5465465\"\n },\n \"customField1\": \"1234\",\n \"customField2\": \"54545\",\n \"customField3\": \"54545\",\n \"status\": {\n \"statusCode\": 1,\n \"statusShortDescription\": \"HTML-FORM-PENDING\"\n }\n },\n \"statusCode\": 200,\n \"achApproval\": [],\n \"receivedPaymentId\": \"054991f2-22a7-4caf-89c7-b40c2511fffc\"\n}"}],"_postman_id":"40d5ccdf-335e-4995-89f2-c6a51ec9066f"},{"name":"Create customer","id":"1ff80b48-1a3b-4690-af24-f243fe43e200","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{AUTH_TOKEN}}","password":"{{AUTH_TOKEN}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"\r\n{\r\n\r\n\"identity\" :\"545654\",\r\n\"customerName\":\"Customer 1\",\r\n\"customerEmail\":\"email@test.com\",\r\n\"customerPhone\":\"900244400\",\r\n\"customerAdderessLine1\":\"95113 mark street rod\",\r\n\"customerCity\":\"Sanjose\",\r\n\"customerState\":\"CA\",\r\n\"customerZip\":\"95113\"\r\n \r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/getpaid-by-form/customer","urlObject":{"path":["getpaid-by-form","customer"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"b8770e2b-fc2b-4053-bf98-2dced64c9b37","name":"Create customer","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"\r\n{\r\n\r\n\"identity\" :\"545654\",\r\n\"customerName\":\"Customer 1\",\r\n\"customerEmail\":\"email@test.com\",\r\n\"customerPhone\":\"900244400\",\r\n\"customerAdderessLine1\":\"95113 mark street rod\",\r\n\"customerCity\":\"Sanjose\",\r\n\"customerState\":\"CA\",\r\n\"customerZip\":\"95113\"\r\n \r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/getpaid-by-form/customer"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8000"},{"key":"Date","value":"Tue, 21 Sep 2021 14:30:04 GMT"},{"key":"Date","value":"Tue, 21 Sep 2021 14:30:04 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.4.13"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"200"},{"key":"X-RateLimit-Remaining","value":"199"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": \"30aedb6c-5976-46e2-a229-030bc299bedb\",\n \"identity\": \"545654\",\n \"customerName\": \"Customer 1\",\n \"customerEmail\": \"email@test.com\",\n \"customerAdderessLine1\": \"95113 mark street rod\",\n \"customerPhone\": \"900244400\",\n \"customerCity\": \"Sanjose\",\n \"customerState\": \"CA\",\n \"customerZip\": \"95113\",\n \"bankAccounts\": [\n []\n ],\n \"createdAt\": \"2021-09-21T14:30:04.000000Z\",\n \"updatedAt\": \"2021-09-21T14:30:04.000000Z\"\n },\n \"statusCode\": 202\n}"}],"_postman_id":"1ff80b48-1a3b-4690-af24-f243fe43e200"},{"name":"Get Customer","id":"05e0adae-27b8-4369-842e-0636276048c6","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"accept":true}},"request":{"auth":{"type":"bearer","bearer":{"token":"{{AUTH_TOKEN}}"},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"{{BASE_URL}}/getpaid-by-form/customer/{customerId}","urlObject":{"path":["getpaid-by-form","customer","{customerId}"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"93d520c5-4216-4020-bca5-e27e61ead752","name":"Get Customer","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"{{BASE_URL}}/getpaid-by-form/customer/30aedb6c-5976-46e2-a229-030bc299bedb"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8000"},{"key":"Date","value":"Tue, 21 Sep 2021 14:33:20 GMT"},{"key":"Date","value":"Tue, 21 Sep 2021 14:33:20 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.4.13"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"200"},{"key":"X-RateLimit-Remaining","value":"199"},{"key":"phpdebugbar-id","value":"Xe5ec0d5e3f8e8a6db94cff391e70a969"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"customer\": {\n \"id\": \"30aedb6c-5976-46e2-a229-030bc299bedb\",\n \"identity\": \"545654\",\n \"customerName\": \"Customer 1\",\n \"customerEmail\": \"email@test.com\",\n \"customerAdderessLine1\": \"95113 mark street rod\",\n \"customerPhone\": \"900244400\",\n \"customerCity\": \"Sanjose\",\n \"customerState\": \"CA\",\n \"customerZip\": \"95113\",\n \"bankAccounts\": [\n []\n ],\n \"createdAt\": \"2021-09-21T14:30:04.000000Z\",\n \"updatedAt\": \"2021-09-21T14:30:04.000000Z\"\n },\n \"statusCode\": 202\n}"}],"_postman_id":"05e0adae-27b8-4369-842e-0636276048c6"},{"name":"Update customer","id":"91b9efa9-f2e4-4652-a894-303d807a8ada","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{AUTH_TOKEN}}","password":"{{AUTH_TOKEN}}"},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"\r\n{\r\n\r\n\"identity\" :\"545654\",\r\n\"customerName\":\"Customer 2\",\r\n\"customerEmail\":\"email@test.com\",\r\n\"customerPhone\":\"900244400\",\r\n\"customerAdderessLine1\":\"95113 mark street rod\",\r\n\"customerCity\":\"Sanjose\",\r\n\"customerState\":\"CA\",\r\n\"customerZip\":\"95113\"\r\n \r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/getpaid-by-form/customer/{{id}}","urlObject":{"path":["getpaid-by-form","customer","{{id}}"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"116d2095-f189-4c6d-b727-561e26bb99d7","name":"Update Customer","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"\r\n{\r\n\r\n\"identity\" :\"545654\",\r\n\"customerName\":\"Customer 2\",\r\n\"customerEmail\":\"email@test.com\",\r\n\"customerPhone\":\"900244400\",\r\n\"customerAdderessLine1\":\"95113 mark street rod\",\r\n\"customerCity\":\"Sanjose\",\r\n\"customerState\":\"CA\",\r\n\"customerZip\":\"95113\"\r\n \r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/getpaid-by-form/customer/{customerId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8000"},{"key":"Date","value":"Tue, 21 Sep 2021 14:31:05 GMT"},{"key":"Date","value":"Tue, 21 Sep 2021 14:31:05 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.4.13"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"200"},{"key":"X-RateLimit-Remaining","value":"199"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Updated.\",\n \"statusCode\": 202\n}"}],"_postman_id":"91b9efa9-f2e4-4652-a894-303d807a8ada"},{"name":"Create Bank Account","id":"5aefa9aa-aeab-4564-9481-05791de71cef","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"accept":true}},"request":{"auth":{"type":"bearer","bearer":{"token":"{{AUTH_TOKEN}}"},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"customerId\":\"bc6cd6a7-c595-4bae-a115-\",\r\n \"accountName\":\"Alison Gambala KRa\",\r\n \"routingNumber\":\"121000358\",\r\n \"accountNumber\":\"123654789534\",\r\n \"accountType\" :\"SAVINGS\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/getpaid-by-form/bank-account/","description":"Create Customer Bank Account
\n","urlObject":{"path":["getpaid-by-form","bank-account",""],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"895dbe81-06e9-40c7-861e-b11cda388836","name":"Create Customer Bank Account","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"customerId\":\"30aedb6c-5976-46e2-a229-030bc299bedb\",\r\n \"accountName\":\"Alison Gambala KRa\",\r\n \"routingNumber\":\"121000358\",\r\n \"accountNumber\":\"123654789534\",\r\n \"accountType\" :\"SAVINGS\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/getpaid-by-form/bank-account/"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8000"},{"key":"Date","value":"Tue, 21 Sep 2021 14:36:03 GMT"},{"key":"Date","value":"Tue, 21 Sep 2021 14:36:03 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.4.13"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"200"},{"key":"X-RateLimit-Remaining","value":"198"},{"key":"phpdebugbar-id","value":"Xd3894235fcc377a310122647dabe9e87"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": \"4ace9721-58cb-410a-b938-efc12ce2c55d\",\n \"accountName\": \"Alison Gambala KRa\",\n \"accountNumber\": \"123654789534\",\n \"routingNumber\": \"121000358\",\n \"accountType\": \"SAVINGS\",\n \"createdAt\": \"2021-09-21T14:36:03.000000Z\",\n \"updatedAt\": \"2021-09-21T14:36:03.000000Z\"\n },\n \"statusCode\": 202\n}"}],"_postman_id":"5aefa9aa-aeab-4564-9481-05791de71cef"},{"name":"Retrieve Bank account","id":"1b24e6b3-955b-423a-bab4-20a5d498e02c","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"accept":true}},"request":{"auth":{"type":"bearer","bearer":{"token":"{{AUTH_TOKEN}}"},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/getpaid-by-form/bank-account/{customerBankAccountId}","description":"Retrieve customer bank account
\n","urlObject":{"path":["getpaid-by-form","bank-account","{customerBankAccountId}"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"273044ba-0ab7-462f-b094-0e0918e3093b","name":"Retreive customer bank account","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"{{BASE_URL}}/getpaid-by-form/bank-account/{customerBankAccountId}"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8000"},{"key":"Date","value":"Tue, 21 Sep 2021 14:38:18 GMT"},{"key":"Date","value":"Tue, 21 Sep 2021 14:38:17 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.4.13"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"200"},{"key":"X-RateLimit-Remaining","value":"198"},{"key":"phpdebugbar-id","value":"X583a75b2353e4e9e95f317eb987c52a1"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": \"4ace9721-58cb-410a-b938-efc12ce2c55d\",\n \"accountName\": \"Alison Gambala KRa\",\n \"accountNumber\": \"123654789534\",\n \"routingNumber\": \"121000358\",\n \"accountType\": \"SAVINGS\",\n \"createdAt\": \"2021-09-21T14:36:03.000000Z\",\n \"updatedAt\": \"2021-09-21T14:36:03.000000Z\"\n },\n \"statusCode\": 202\n}"}],"_postman_id":"1b24e6b3-955b-423a-bab4-20a5d498e02c"},{"name":"Update Bank Account","id":"4f32939c-c551-4910-886f-eb1e16d07e7b","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"accept":true}},"request":{"auth":{"type":"bearer","bearer":{"token":"{{AUTH_TOKEN}}"},"isInherited":false},"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"customerId\":\"bc6cd6a7-c595-4bae-a115-353f73354603\",\r\n \"accountName\":\"Alison Gambala KRa\",\r\n \"routingNumber\":\"121000358\",\r\n \"accountNumber\":\"123654789534\",\r\n \"accountType\" :\"SAVINGS\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/getpaid-by-form/bank-account/{customerBankAccountId}","urlObject":{"path":["getpaid-by-form","bank-account","{customerBankAccountId}"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"2131c65a-cee2-4e3f-9728-14f3defd53df","name":"Update customer bank account","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"customerId\":\"30aedb6c-5976-46e2-a229-030bc299bedb\",\r\n \"accountName\":\"Alison Gambala KRa\",\r\n \"routingNumber\":\"121000358\",\r\n \"accountNumber\":\"123654789534\",\r\n \"accountType\" :\"SAVINGS\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/getpaid-by-form/bank-account/4ace9721-58cb-410a-b938-efc12ce2c55d"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8000"},{"key":"Date","value":"Tue, 21 Sep 2021 14:37:31 GMT"},{"key":"Date","value":"Tue, 21 Sep 2021 14:37:31 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.4.13"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"200"},{"key":"X-RateLimit-Remaining","value":"198"},{"key":"phpdebugbar-id","value":"X4566ae9e584aea720183ee25ebaadee2"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": \"4ace9721-58cb-410a-b938-efc12ce2c55d\",\n \"accountName\": \"Alison Gambala KRa\",\n \"accountNumber\": \"123654789534\",\n \"routingNumber\": \"121000358\",\n \"accountType\": \"SAVINGS\",\n \"createdAt\": \"2021-09-21T14:36:03.000000Z\",\n \"updatedAt\": \"2021-09-21T14:36:03.000000Z\"\n },\n \"statusCode\": 202\n}"}],"_postman_id":"4f32939c-c551-4910-886f-eb1e16d07e7b"},{"name":"Initiate Direct Deposit","id":"92b49f12-bc0e-44c4-867e-4512d3e30178","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"accept":true}},"request":{"auth":{"type":"bearer","bearer":{"token":"{{AUTH_TOKEN}}","password":"{{AUTH_TOKEN}}"},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/getpaid-by-form/check/{referenceId}/direct-deposit","description":"You can initiate direct deposit using check referenceId
The allowed statuses are GPBL Acpt/Rej , GPBL Viewed , GPBL Accepted & GPBL TTP
\nThe associated deposit bank account should be approved for ACH .
\n","urlObject":{"path":["getpaid-by-form","check","{referenceId}","direct-deposit"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"92b49f12-bc0e-44c4-867e-4512d3e30178"},{"name":"Retrieve Single Payment","id":"3f4afb42-17a8-4006-ab80-23b2364c44d2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"You can retrieve a single payment link check using referenceId
To create a payment link, follow these steps:
\nIn the case where the customer is the same and their bank account is also the same, you can simplify the process by creating the customer and adding their bank account first. Then, when calling the \"Create Payment\" API, you can pass the customer ID and the customer's bank account ID instead of passing all the data.
\nIf you have any further questions, feel free to reach out to our developer or customer support team. To ensure that our engineer can effectively guide you on the appropriate API to use, please send a detailed description of your use case along with a video explanation (using Loom) to support@onlinecheckwriter.com.
\nPlease be aware that the large IDs (e.g. y3n1ZoVelEBj8pwba62) are case-sensitive. When storing these IDs, it is crucial to maintain their case sensitivity to prevent unexpected results.
\nFor instance
\ny3n1ZoVelEBj8Pwba62
\ny3n1ZoVelEBj8pwba62
\ncan be different value.
\nStatus and descriptions
\n| Status code | Short description | Full description |
|---|---|---|
| 1 | GPBL Acpt/Rej | Accept Or Reject This Check, Got Paid By Your Dedicated Bank Ac Link |
| 2 | GPBL Viewed | You Viewed This Check, Now Accept/Reject, then Print/Direct Deposit It. You Can Print On Check Paper Or Plain Paper |
| 3 | GPBL Rejected | You Rejected This Check, Got Paid By Your Dedicated Bank Ac Link |
| 4 | GPBL Accepted | You Accepted This Check, Print/Direct Deposit Now. You Can Print On Check Paper Or Plain Paper |
| 5 | GPBL TTP | You Tried To Print This Check & Marked As NOT PRINTED. Sender Gets this Notification. |
| 6 | GPBL Printed | You Printed This Check, Got Paid By Your Dedicated Bank Ac Link |
| 50 | DD Initiated | Initiated & Processing. You get paid this by Get paid Link. |
| 51 | DD Completed | DD Completed and Credited. Got Paid by Link. |
| 52 | DD Failed | DD Failed. Please Click on the View-eyeball button to see the reason. |
To enable this feature, please reach out to our customer support team. Follow these steps to proceed:
\nAdd a card through the User Interface (UI).
Use the 'Get Cards' API to retrieve the card ID.
Utilize this card ID as needed.
Please contact our customer support team to activate this feature.
\n","_postman_id":"9be13f4e-e3b1-4e1b-9639-edcd2f5cad34"},{"name":"Glossary","item":[],"id":"8d05e4e0-74b9-4072-b5d7-d917c6ba6071","description":"| Method | Description |
|---|---|
GET | Retrieving resources |
POST | Creating resources/Perform actions |
PUT | Updating resources |
DELETE | Deleting resources |
| Method | Description |
|---|---|
200 | Success |
201 | Created |
400 | Bad request |
401 | Unauthorized |
403 | Forbidden |
404 | URL /Resource Not Found |
405 | Method Not Allowed |
422 | Unprocessable entity |
429 | Too many requests |
500 | Server error |
Success Response
\n| Attributes | Description |
|---|---|
success | Always true for successful response |
message | Success messages for any resource operations |
data | Requested resources |
Failure Response
\n| Attributes | Description |
|---|---|
success | Always false for failure response |
errorMsg | Human-readable error message |
| Status | Description | Meaning |
|---|---|---|
| 400 | DD | Direct Deposit Initiated |
| 410 | DD-FUNDING | Funding started |
| 411 | DD | Funding completed |
| 412 | DD Failed | DD Funding Failed PF |
| 420 | DDC | DD Completed/Credited receiver wallet |
| 430 | DD-DEPOSITING | Depositing started |
| 431 | DDC | Direct deposit completed |
| 432 | DD-DEPOSIT-F | Direct deposit failed |
| 433 | DD-BA-NOT-VERIFIED | Bank account verification required for depositing |
| 440 | DD/F | Direct Deposit Failed |
| 441 | DDR | DD returned(deposit) |
Shipping Types
\n| Shipping Type Id | Description |
|---|---|
1 | First Class |
3 | First Class with Tracking |
4 | Priority Mail |
5 | Express Mail |
12 | Standard Overnight -Fedex-By 3pm the next business day |
20 | Fedex Satureday Delivery |
Paper Types
\n| Paper Type Id | Description |
|---|---|
7 | Regular Check Paper |
8 | Hollogram Check Paper |
9 | Ultra Hollogram Check Paper |
Inform Types
\n| Inform Type Id | Description |
|---|---|
10 | Notify Receiver by Sms |
| Status code | Short description | Full description |
|---|---|---|
0 | New | New |
1 | Printed | Printed |
2 | Void | Voided |
3 | Arc | Achieved |
4 | Printing | Check Mailing - Printing |
5 | Printed | Check Mailing - Printed Your Check |
6 | Printed | Check Mailing - Printed Envelop |
7 | Mailed | Check Mailing - Mailed |
8 | Printed | Check Mailing - Mailed(Reservered For Manual Action) |
11 | Refunded | Check Mailing - Refunded (Please call our customer support & resolve the issue) |
12 | E-Mailed | E-Mailed |
13 | E-Mailed | E-Mailed |
14 | E-Printed | E-Printed |
50 | Schedule | Schedule For Future Mailing |
300 | DD | Direct Deposit |
301 | DD | Direct Deposit is not deposited from receiver |
302 | DD | Direct Deposit Initiated |
303 | DD | Direct Deposit Processing |
304 | DDC | Direct Deposit Completed |
305 | DD/F | Direct Deposit Failed |
306 | DD/V | Direct Deposit Voided |
308 | Pushing | Processing on Pushing |
311 | DD/R | Return From Provider |
312 | DD/R | Reject from Operator. Please call our customer support team for further query |
313 | DD/AR | Application Rejected |
Date:8.15.2024
\nAdd a new feature under Quickpay called \"sendpdf\" that allows users to quickly send PDFs directly from a URL
\nDate:8.16.2024
\nAdded Delivery method called Fedex Satuready Delivery in API.
\nDate:3/11/2024
\nDirect Document Mailing: You can now mail PDF documents directly from your OnlineCheckWriter portal or via our API. This streamlines your workflow, allowing you to send important documents seamlessly to clients or stakeholders.
\nDynamic HTML Email Templates for Document Mailing
Create visually rich HTML email templates and we'll convert them to professional PDF documents for you. Customize the templates with placeholders, and we'll dynamically update the content to generate personalized PDF documents for mailing. Perfect for sending branded invoices, statements, or any other document types!EndFragment
Date:07/09/2023
\nAnnouncing the Quick Pay Feature: Fast and Efficient Payment Solutions via API for Checks, E-Checks, Mail Checks, Direct Deposits, Virtual Cards, and Wire Transfers
\nDate: 02/09/2023
\nIntroducing a Beta Version: Now Pay with Credit Card via API
\n","_postman_id":"41319c71-f1b6-456a-80b9-9285e6fb67ec"},{"name":"Support/Instant Help","item":[],"id":"e81582c1-1e07-4a19-ae2f-508960ee415b","description":"Phone (408) 775-7720
Email : support@onlinecheckwriter.com
Live Chat : Click Here
We strongly recommend watching the video if you've missed it.
Click here to watch API integration video.
If you require an API that isn't publicly listed, please reach out to us. We may have it available privately. For any improvement or feature requests, you can email us at support@onlinecheckwriter.com.
\nLogin Url : https://test.onlinecheckwriter.com/
\nUsername : ocw_sandbox@gmail.com
password : Qwert789**
AUTH_TOKEN: Login and get it (plz don't change it)
\nwalletId:4779ba42-ad70-4943-82ca-83ee29323ee2
\nbankaccountId: QEmZGEAmZWGaw3vNO
\nIf you are looking for quick SDK:
\nPhp Sdk - https://packagist.org/packages/onlinecheckwriter/quickpay
\nPython Sdk - https://pypi.org/project/onlinecheckwriter-quickpay/
\nNodejs Sdk - https://github.com/onlinecheckwriter/quickpay-nodejs-sdk
\nHMAC-SHA256 of the raw JSON request body, signed with your webhook_secret: hash_hmac('sha256', rawJsonBody, webhookSecret)
\n"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://your-server.com/webhooks/zilmoney","description":"Triggered when a user initiates an ACH withdrawal from their Zil Money wallet to a linked bank account.
\nTrigger: User withdraws funds from their Zil Money wallet to an external bank account via ACH.
\nHMAC-SHA256 of the raw JSON request body, signed with your webhook_secret: hash_hmac('sha256', rawJsonBody, webhookSecret)
\n"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://your-server.com/webhooks/zilmoney","description":"Triggered when the status of a wallet ACH withdrawal changes.
\nTrigger: The withdrawal transfer status is updated by the banking network.
\nSame schema as wallet.withdraw.ach.initiated. The data.status and data.updatedAt fields reflect the new state.
HMAC-SHA256 of the raw JSON request body, signed with your webhook_secret: hash_hmac('sha256', rawJsonBody, webhookSecret)
\n"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://your-server.com/webhooks/zilmoney","description":"Triggered when a user initiates a wire transfer withdrawal from their Zil Money wallet to a linked bank account.
\nTrigger: User submits a wire withdrawal from their wallet.
\nHMAC-SHA256 of the raw JSON request body, signed with your webhook_secret: hash_hmac('sha256', rawJsonBody, webhookSecret)
\n"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://your-server.com/webhooks/zilmoney","description":"Triggered whenever the status of a wire withdrawal changes. This event fires multiple times across the transfer lifecycle.
\nTrigger: Wire transfer status is updated by the banking network.
\nPENDING → PROCESSING → COMPLETED\n ↘ FAILED\nPENDING → CANCELED\n\n\nThis event fires once per status transition. The sample shows the first update (
\nPROCESSING). A second fire will follow when status moves toCOMPLETEDorFAILED.
Same schema as wallet.withdraw.wire.initiated. The data.status and data.updatedAt fields reflect the new state.
HMAC-SHA256 of the raw JSON request body, signed with your webhook_secret: hash_hmac('sha256', rawJsonBody, webhookSecret)
\n"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://your-server.com/webhooks/zilmoney","description":"Triggered when a user initiates a wallet withdrawal via physical check mailing. A check will be printed and mailed to the specified recipient address.
\nTrigger: User creates a check mail withdrawal from their Zil Money wallet.
\nHMAC-SHA256 of the raw JSON request body, signed with your webhook_secret: hash_hmac('sha256', rawJsonBody, webhookSecret)
\n"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://your-server.com/webhooks/zilmoney","description":"Triggered whenever the status of a check mail withdrawal changes. This event fires multiple times across the check's lifecycle.
\nTrigger conditions:
\nPENDING → PROCESSING → COMPLETED)\n\nThis sample shows the first update (status change only). Fields populate in later fires.
\n
\n\n","urlObject":{"protocol":"https","path":["webhooks","zilmoney"],"host":["your-server","com"],"query":[],"variable":[]}},"response":[{"id":"44f8eb25-62f0-4e28-8450-2f4d490ed6de","name":"wallet.withdraw.check.mail.updated","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Signature","value":"{{hmac_signature}}","description":"HMAC-SHA256 of the raw JSON request body, signed with your webhook_secret: hash_hmac('sha256', rawJsonBody, webhookSecret)"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://your-server.com/webhooks/zilmoney"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"event\": {\n \"type\": \"wallet.withdraw.check.mail.updated\",\n \"id\": \"e5f6a7b8-c9d0-1234-efab-678901234568\",\n \"createdAt\": \"2024-01-16T08:30:00.000000Z\",\n \"data\": {\n \"id\": \"f7a8b9c0-d1e2-3456-fab7-890123456789\",\n \"fromWallet\": \"deab2f42-8b8b-47ad-b766-eacc632df634\",\n \"amount\": \"1.25\",\n \"description\": \"Wallet Withdraw :Mail\",\n \"shippingType\": \"FEDEX_NEXT_DAY_PM\",\n \"shippingInfo\": {\n \"trackingNumber\": null,\n \"trackingUrl\": null\n },\n \"status\": \"PROCESSING\",\n \"clearingFile\": null,\n \"previewFile\": null,\n \"reviewMessage\": \"\",\n \"updatedAt\": \"2026-02-23T06:53:15.000000Z\",\n \"createdAt\": \"2026-02-23T06:53:14.000000Z\",\n \"fromAddress\": {\n \"name\": \"Acme Corporation\",\n \"addressLine1\": \"123 Business Ave\",\n \"addressLine2\": \"Suite 100\",\n \"city\": \"Austin\",\n \"state\": \"TX\",\n \"zip\": \"78701\"\n },\n \"toAddress\": {\n \"name\": \"John Smith\",\n \"addressLine1\": \"456 Main Street\",\n \"addressLine2\": \"\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"zip\": \"10001\"\n }\n }\n }\n}"}],"_postman_id":"1aa236e8-5d19-4b53-934c-8773ca231341"}],"id":"a12bda81-6bcc-405f-acee-3753f18494aa","_postman_id":"a12bda81-6bcc-405f-acee-3753f18494aa","description":""}],"id":"21552476-674d-4b78-bee9-81352aebba10","description":"Note: Pre-signed S3 URLs for
\nclearingFileandpreviewFileexpire — download promptly after receiving.
Events fired when a user withdraws funds from their Zil Money wallet.
\nHMAC-SHA256 of the raw JSON request body, signed with your webhook_secret: hash_hmac('sha256', rawJsonBody, webhookSecret)
\n"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://your-server.com/webhooks/zilmoney","description":"Triggered when a user initiates an ACH transfer to fund their Zil Money wallet from a linked bank account.
\nTrigger: User adds funds to their Zil Money wallet via ACH bank pull.
\nHMAC-SHA256 of the raw JSON request body, signed with your webhook_secret: hash_hmac('sha256', rawJsonBody, webhookSecret)
\n"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://your-server.com/webhooks/zilmoney","description":"Triggered when the status of a wallet ACH funding transfer changes.
\nTrigger: The ACH funding transfer status is updated (e.g., bank settles the pull, or it is returned/failed).
\nSame schema as wallet.funding.ach.initiated. The data.status and data.updatedAt fields will reflect the latest state.
HMAC-SHA256 of the raw JSON request body, signed with your webhook_secret: hash_hmac('sha256', rawJsonBody, webhookSecret)
\n"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://your-server.com/webhooks/zilmoney","description":"Triggered when a wallet fund request is created — a request for an external party to wire funds into a Zil Money wallet. The depositInformation object contains the beneficiary bank details that the depositor should use to complete the wire transfer.
Trigger: A fund request is created via the Zil Money platform or API.
\n\n\n","urlObject":{"protocol":"https","path":["webhooks","zilmoney"],"host":["your-server","com"],"query":[],"variable":[]}},"response":[{"id":"042f2f64-fc15-4473-97fb-7aa8b028d6ca","name":"wallet.funding.request.initiated","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Signature","value":"{{hmac_signature}}","description":"HMAC-SHA256 of the raw JSON request body, signed with your webhook_secret: hash_hmac('sha256', rawJsonBody, webhookSecret)"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://your-server.com/webhooks/zilmoney"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"event\": {\n \"type\": \"wallet.funding.request.initiated\",\n \"id\": \"55c6683a-6b7c-4410-b3e3-3ad4cd4b1ff0\",\n \"createdAt\": \"2024-10-25T09:45:16.000000Z\",\n \"data\": {\n \"id\": \"afce0ae6-03d6-40e9-b5fd-152afa174054\",\n \"depositorName\": \"JOHN DOE\",\n \"toWallet\": \"4692095d-4606-4731-be31-5cc933837b34\",\n \"amount\": \"145.00\",\n \"description\": \"test from api\",\n \"status\": \"PENDING\",\n \"transferType\": \"domestic-wire\",\n \"depositInformation\": {\n \"beneficiaryName\": \"ABC LLC\",\n \"beneficiaryRoutingNumber\": \"121140399\",\n \"beneficiaryAccountNumber\": \"3304236682\",\n \"beneficiaryAccountType\": \"Business Checking\",\n \"beneficiaryBankAddress\": \"3003 Tasman Drive, Santa Clara, CA 95054, USA\",\n \"beneficiaryBankSwift\": \"SVBKUS6S\",\n \"specialInstruction\": \"ZM OF33 OCW ABC LLC\"\n },\n \"updatedAt\": \"2024-10-25T09:45:15.000000Z\",\n \"createdAt\": \"2024-10-25T09:45:15.000000Z\"\n }\n }\n}"}],"_postman_id":"f2b5a134-0182-4f87-b2ba-946bf6ca9885"},{"name":"wallet.funding.request.updated","id":"9db8207a-2ac0-4df6-a8f6-9f56a5665a76","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Signature","value":"{{hmac_signature}}","description":"Important: Share the
\ndepositInformationfields with the depositor so they can correctly initiate the wire. ThespecialInstructionmust be included in the wire memo to ensure the funds are credited to the correct wallet.
HMAC-SHA256 of the raw JSON request body, signed with your webhook_secret: hash_hmac('sha256', rawJsonBody, webhookSecret)
\n"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://your-server.com/webhooks/zilmoney","description":"Triggered when the status of a wallet fund request changes — typically when the wire is received and the wallet is credited.
\nTrigger: The fund request status is updated (e.g., wire received and matched → COMPLETED).
PENDING → COMPLETED (wire received and matched)\n ↘ FAILED (wire not received / rejected)\n ↘ CANCELED (request canceled)\nSame schema as wallet.funding.request.initiated. The data.status and data.updatedAt fields reflect the new state.
Events fired when a user adds funds to their Zil Money wallet.
\n","_postman_id":"a1262bed-d228-4ef6-9efd-9192a6e19473"}],"id":"25c5cc24-1a2e-4941-8a38-08e2418eb5de","description":"Events related to wallet transactions — withdrawals and funding across different payment rails.
\n","_postman_id":"25c5cc24-1a2e-4941-8a38-08e2418eb5de"},{"name":"Send Payment","item":[{"name":"sendPayment.updated","id":"b98043aa-a1ec-4d9d-9e6c-ca53b3e5fc93","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Signature","value":"{{hmac_signature}}","description":"HMAC-SHA256 of the raw JSON request body, signed with your webhook_secret: hash_hmac('sha256', rawJsonBody, webhookSecret)
\n"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://your-server.com/webhooks/zilmoney","description":"Triggered whenever an outgoing payment status changes. The event fires for all payment methods — only the transferType, source, and a few additional fields differ per method. The rest of the payload structure is identical.
The sample body shows an ACH payment. All other payment methods share this same envelope.
\nOnly the fields shown below differ between payment types. All other fields remain identical.
\n{\n \"data\": {\n \"transferType\": \"ach\",\n \"source\": {\n \"sourceType\": \"bankAccount\",\n \"sourceId\": \"<encrypted-bank-account-id>\"\n },\n \"reviewMessage\": \"\" // populated with ACH return reason on FAILED status\n }\n}\n{\n \"data\": {\n \"transferType\": \"wire\",\n \"source\": {\n \"sourceType\": \"bankAccount\",\n \"sourceId\": \"<encrypted-bank-account-id>\"\n },\n \"reviewMessage\": \"\" // populated with wire return description on FAILED status\n }\n}\n{\n \"data\": {\n \"transferType\": \"checkMail\",\n \"source\": {\n \"sourceType\": \"wallet\",\n \"sourceId\": \"<wallet-uuid>\" // wallet UUID, not encrypted ID\n },\n \"reviewMessage\": null,\n \"clearingFile\": null, // pre-signed S3 URL after printing\n \"previewFile\": null, // pre-signed S3 URL after printing\n \"tracking\": null // tracking object after carrier pickup\n }\n}\n\n\n","urlObject":{"protocol":"https","path":["webhooks","zilmoney"],"host":["your-server","com"],"query":[],"variable":[]}},"response":[{"id":"b5848438-50da-4d19-b087-ef04d8ce00b8","name":"ACH","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Signature","value":"{{hmac_signature}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://your-server.com/webhooks/zilmoney"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"event\": {\n \"type\": \"sendPayment.updated\",\n \"id\": \"fb8e75e5-b3ab-4539-a004-80ba5948432d\",\n \"createdAt\": \"2026-02-21T08:53:58.000000Z\",\n \"data\": {\n \"id\": \"af126fac-cd3a-47a7-8fed-8727ad63235b\",\n \"amount\": \"10.00\",\n \"payeeId\": \"dJM5GbMbxv4Y329\",\n \"transferType\": \"ach\",\n \"referenceNo\": \"\",\n \"status\": \"PROCESSING\",\n \"description\": \"\",\n \"source\": {\n \"sourceType\": \"bankAccount\",\n \"sourceId\": \"qx5NrWjyoA1NG2n3l6b\"\n },\n \"reviewMessage\": \"\",\n \"createdAt\": \"2026-02-21T08:53:53.000000Z\",\n \"updatedAt\": \"2026-02-21T08:53:58.000000Z\"\n }\n }\n}"},{"id":"d0fcb1f5-8da8-40a6-9350-4288a61c8d8a","name":"Wire Transfer","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Signature","value":"{{hmac_signature}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://your-server.com/webhooks/zilmoney"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"event\": {\n \"type\": \"sendPayment.updated\",\n \"id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567891\",\n \"createdAt\": \"2024-01-15T15:00:00.000000Z\",\n \"data\": {\n \"id\": \"b2c3d4e5-f6a7-8901-bcde-f12345678901\",\n \"amount\": \"5000.00\",\n \"payeeId\": \"dJM5GbMbxv4Y330\",\n \"transferType\": \"wire\",\n \"referenceNo\": \"\",\n \"status\": \"PROCESSING\",\n \"description\": \"\",\n \"source\": {\n \"sourceType\": \"bankAccount\",\n \"sourceId\": \"qx5NrWjyoA1NG2n3l6c\"\n },\n \"reviewMessage\": \"\",\n \"createdAt\": \"2024-01-15T10:30:00.000000Z\",\n \"updatedAt\": \"2024-01-15T15:00:00.000000Z\"\n }\n }\n}"},{"id":"692258b0-a116-4e26-a173-cecaa69992a0","name":"Check Mail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Signature","value":"{{hmac_signature}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://your-server.com/webhooks/zilmoney"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"event\": {\n \"type\": \"sendPayment.updated\",\n \"id\": \"592135ff-b8a2-44aa-b075-1acb7b23af5c\",\n \"createdAt\": \"2026-02-27T05:11:04.000000Z\",\n \"data\": {\n \"id\": \"121023be-972f-4bb3-b194-3412bfd69087\",\n \"amount\": \"55.00\",\n \"payeeId\": \"dNDOGnBoD7G0oMX\",\n \"transferType\": \"checkMail\",\n \"referenceNo\": \"1234\",\n \"status\": \"PROCESSING\",\n \"description\": \"VC to GolbalTech\",\n \"source\": {\n \"sourceType\": \"wallet\",\n \"sourceId\": \"8ea7b519-1b0b-4a3d-8f49-18ae1fc49655\"\n },\n \"reviewMessage\": null,\n \"clearingFile\": null,\n \"previewFile\": null,\n \"tracking\": null,\n \"createdAt\": \"2026-02-27T05:10:46.000000Z\",\n \"updatedAt\": \"2026-02-27T05:11:03.000000Z\"\n }\n }\n}"}],"_postman_id":"b98043aa-a1ec-4d9d-9e6c-ca53b3e5fc93"}],"id":"7e487e19-c2e2-444d-b9ec-ed7e21784273","description":"Check Mail only:
\nclearingFile,previewFile, andtrackingare extra fields not present in ACH or Wire payloads.
Events for all outgoing payments made via the Send Payment flow — ACH, wire transfer, and check mail. All variants share the same sendPayment.updated event type with a consistent payload structure. Only transferType, source, reviewMessage, and a few additional fields differ per payment method.
HMAC-SHA256 of the raw JSON request body, signed with your webhook_secret: hash_hmac('sha256', rawJsonBody, webhookSecret)
\n"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://your-server.com/webhooks/zilmoney","description":"Triggered when a customer submits a Get Paid By Form (GPBF) payment, creating a new eCheck/digital check record.
\nTrigger: A customer fills out and submits the payment form sent by a Zil Money user. A GetPaidByFormCheck record is created in the system.
HMAC-SHA256 of the raw JSON request body, signed with your webhook_secret: hash_hmac('sha256', rawJsonBody, webhookSecret)
\n"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://your-server.com/webhooks/zilmoney","description":"Triggered whenever the status of a GPBF eCheck/digital check payment changes.
\nTrigger: The received check status is updated in the system (e.g., payment clears, fails, or is returned). Fires only when the status field changes on a ReceivedCheckList record with received_type = 4.
Same schema as gpbf.check.created. Key fields that change on update:
statusCode is a database-driven integer — not a fixed enum. The value depends on the central_received_check_status table entries for received_type = 4statusShortDescription is the status_short_description column from the same tablemetaData is always an array ([] when empty, not an object {})serialNumber is always an integer, not a stringHMAC-SHA256 of the raw JSON request body, signed with your webhook_secret: hash_hmac('sha256', rawJsonBody, webhookSecret)
\n"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://your-server.com/webhooks/zilmoney","description":"Triggered when a manual ACH pull transfer is created by a Zil Money user.
\nTrigger: User initiates a manual ACH pull from a connected bank account into their Zil Money wallet.
\nHMAC-SHA256 of the raw JSON request body, signed with your webhook_secret: hash_hmac('sha256', rawJsonBody, webhookSecret)
\n"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://your-server.com/webhooks/zilmoney","description":"Triggered whenever the status of a manual ACH pull transfer changes.
\nTrigger: The ACH transfer status is updated by the banking network (e.g., moves from PENDING → PROCESSING → COMPLETED, or FAILED / RETURNED).
PENDING → PROCESSING → COMPLETED\n ↘ FAILED\nCOMPLETED → RETURNED (ACH return received post-settlement)\nPENDING → CANCELED (user canceled before processing)\nSame schema as manual-ach.initiated. The data.status field will reflect the new status, and data.updatedAt will be updated.
Events for incoming payments received through Get Paid By Form (GPBF) payment links and manual ACH pulls.
\n","_postman_id":"69b0fa04-aa4a-47e3-85f3-e9bee62d07e3"},{"name":"Card Program","item":[{"name":"Card Program Events","item":[{"name":"card-program.card.created","id":"e081276b-74c1-451e-ba8b-1027a2fa70e1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Signature","value":"{{hmac_signature}}","description":"HMAC-SHA256 of the raw JSON request body, signed with your webhook_secret: hash_hmac('sha256', rawJsonBody, webhookSecret)
\n"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://your-server.com/webhooks/zilmoney","description":"Triggered when a new card program issuing record (virtual or physical card) is successfully created for a user.
\nTrigger: A CardProgramIssuingRecord is created and the card is issued via the card network.
HMAC-SHA256 of the raw JSON request body, signed with your webhook_secret: hash_hmac('sha256', rawJsonBody, webhookSecret)
\n"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://your-server.com/webhooks/zilmoney","description":"Triggered when a new card transaction is recorded — typically when an authorization is received from the card network.
\nTrigger: A CardProgramCardTransaction record is created (e.g., cardholder makes a purchase).
HMAC-SHA256 of the raw JSON request body, signed with your webhook_secret: hash_hmac('sha256', rawJsonBody, webhookSecret)
\n"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://your-server.com/webhooks/zilmoney","description":"Triggered when a card transaction status changes — e.g., an authorization settles, is reversed, or is declined after initially pending.
\nTrigger: A CardProgramCardTransaction record is updated with a new status or reviewed state.
Same schema as card-program.card.transaction.created. The data.status field reflects the new transaction state.
APPROVED → SETTLED (authorization settles, typically T+1)\nAPPROVED → REVERSED (merchant voids/reverses the transaction)\nPENDING → APPROVED (authorization completes)\nPENDING → DECLINED (authorization denied)\nEvents related to virtual and physical card issuance and card transactions managed through the Zil Money Card Program.
\n","_postman_id":"5d06d9a1-c892-4603-915b-0b6928fdf940"},{"name":"Check","item":[{"name":"Print","item":[{"name":"check.print.async (success)","id":"31731cc4-dffd-4d49-9747-31af56453e11","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Signature","value":"{{hmac_signature}}","description":"HMAC-SHA256 of the raw JSON request body, signed with your webhook_secret: hash_hmac('sha256', rawJsonBody, webhookSecret)
\n"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://your-server.com/webhooks/zilmoney","description":"Triggered when an asynchronous check print job completes successfully. The PDF is ready to download from the provided URL.
\nTrigger: AsynchronousCheckPrintJob finishes generating the print PDF for one or more checks.
\n\n","urlObject":{"protocol":"https","path":["webhooks","zilmoney"],"host":["your-server","com"],"query":[],"variable":[]}},"response":[{"id":"e66ea64c-4d7e-4337-b751-dbd38f87f0b4","name":"check.print.async (success)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Signature","value":"{{hmac_signature}}","description":"HMAC-SHA256 of the raw JSON request body, signed with your webhook_secret: hash_hmac('sha256', rawJsonBody, webhookSecret)"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://your-server.com/webhooks/zilmoney"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"event\": {\n \"type\": \"check.print.async\",\n \"id\": \"a9b0c1d2-e3f4-5678-abcd-ef1234567890\",\n \"createdAt\": \"2024-01-15T12:30:00.000000Z\",\n \"data\": {\n \"status\": \"success\",\n \"requestId\": \"req-7f3c2a1b-4e5d-6f7a-8b9c-0d1e2f3a4b5c\",\n \"url\": \"https://s3.amazonaws.com/zilmoney-prints/checks/batch_a9b0c1d2.pdf?Expires=1705401600&Signature=...\",\n \"checkIds\": [\n \"CHK_enc_a1b2c3d4e5f6\",\n \"CHK_enc_b2c3d4e5f6a7\",\n \"CHK_enc_c3d4e5f6a7b8\"\n ]\n }\n }\n}"}],"_postman_id":"31731cc4-dffd-4d49-9747-31af56453e11"},{"name":"check.print.async (failed)","id":"abaacd6e-d6ab-492c-97e4-93afe1f29d3b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Signature","value":"{{hmac_signature}}","description":"Note: The
\ndata.urlis a pre-signed S3 URL. Download the PDF as soon as possible after receiving this event.
HMAC-SHA256 of the raw JSON request body, signed with your webhook_secret: hash_hmac('sha256', rawJsonBody, webhookSecret)
\n"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://your-server.com/webhooks/zilmoney","description":"Triggered when an asynchronous check print job fails — the PDF could not be generated.
\nTrigger: AsynchronousCheckPrintJob encounters an error (PDF generation failure, page count mismatch, or upstream error).
HMAC-SHA256 of the raw JSON request body, signed with your webhook_secret: hash_hmac('sha256', rawJsonBody, webhookSecret)
\n"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://your-server.com/webhooks/zilmoney","description":"Triggered each time a carrier tracking update is received for a mailed check. This event fires multiple times as the check moves through the postal network.
\nTrigger: A new carrier tracking scan is recorded for the check's tracking number.
\nHMAC-SHA256 of the raw JSON request body, signed with your webhook_secret: hash_hmac('sha256', rawJsonBody, webhookSecret)
\n"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://your-server.com/webhooks/zilmoney","description":"Triggered each time a carrier tracking update is received for a mailed document. Fires multiple times as the document moves through the postal network.
\nTrigger: A new carrier tracking scan is recorded for a BusinessToolsDocumentMailing record.
\n\nNote: Unlike
\ncheck.mailing.tracking, document tracking events do not include agroupIdfield.
Events related to check printing, mailing, and delivery tracking.
\n","_postman_id":"f96455ff-4968-4e85-bb76-a130b36ee497"}],"id":"18d814d2-1517-49b4-a97c-ae6727cccdcc","description":"The Zil Money Webhook Integration Guide provides comprehensive documentation for all webhook events generated by the Zil Money platform.
\nEach webhook event is delivered as an HTTP POST request to your registered endpoint whenever a corresponding action occurs within the system, ensuring your application receives timely and reliable event data directly from Zil Money.
\nZil Money webhooks enable your application to receive real-time notifications when platform events occur, including ACH transfers, check mailings, wallet-associated transactions, eCheck payments, GPBF payments, and more.
\nBy integrating webhooks, you can automate business workflows, synchronize transaction data, trigger internal processes, and maintain accurate, up-to-date records within your system.
\nTo receive webhooks:
\nNavigate to Developer Panel → Webhooks in your Zil Money dashboard
\nRegister your endpoint URL (webhook_url)
Optionally set a Webhook Secret (webhook_secret) to enable signature verification
Select the specific event types you want to subscribe to
\nAll OCW (OnlineCheckWriter/Zil Money) webhook events share a common envelope structure:
\n{\n \"event\": {\n \"type\": \"event.type.name\",\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"createdAt\": \"2024-01-15T10:30:00.000000Z\",\n \"data\": { }\n }\n}\n\nWhen a webhook_secret is configured, every request is signed using HMAC-SHA256.
The signature is computed over the raw JSON body of the request:
\nSignature = HMAC-SHA256(rawJsonBody, webhook_secret)\n\nThis is implemented using the Spatie Laravel Webhook Server DefaultSigner:
// Sender side (Zil Money)\nhash_hmac('sha256', json_encode($payload), $webhookSecret);\n\nPHP:
\n$signature = $request->header('Signature');\n$rawBody = $request->getContent(); // raw JSON string\n$expected = hash_hmac('sha256', $rawBody, $webhookSecret);\n$isValid = hash_equals($expected, $signature);\nif (!$isValid) {\n http_response_code(401);\n exit('Invalid signature');\n}\n\nNode.js (Express):
\nconst crypto = require('crypto');\n// IMPORTANT: use raw body buffer, not parsed JSON\napp.post('/webhooks/zilmoney', express.raw({ type: 'application/json' }), (req, res) => {\n const signature = req.headers['signature'];\n const rawBody = req.body.toString();\n const expected = crypto\n .createHmac('sha256', process.env.WEBHOOK_SECRET)\n .update(rawBody)\n .digest('hex');\n const isValid = crypto.timingSafeEqual(\n Buffer.from(expected, 'hex'),\n Buffer.from(signature, 'hex')\n );\n if (!isValid) return res.status(401).send('Invalid signature');\n // process event...\n res.status(200).send('OK');\n});\n\nPython (Flask):
\nimport hmac, hashlib\nfrom flask import request, abort\n@app.route('/webhooks/zilmoney', methods=['POST'])\ndef webhook():\n signature = request.headers.get('Signature', '')\n raw_body = request.get_data() # raw bytes, before any parsing\n expected = hmac.new(\n WEBHOOK_SECRET.encode(),\n raw_body,\n hashlib.sha256\n ).hexdigest()\n if not hmac.compare_digest(expected, signature):\n abort(401)\n # process event...\n return 'OK', 200\n\n\n\nCritical: Always read the raw request body bytes before any JSON parsing. Parsers may reformat the JSON (different key ordering or whitespace), which will break the HMAC check.
\n
\n\nSecurity tip: Always use a constant-time comparison (
\nhash_equals,timingSafeEqual,hmac.compare_digest) to prevent timing attacks.
If all 3 attempts fail, the event status is updated to FAILED in your Webhook Log.
\nYou can manually retry failed events from the Developer Panel
\nTo protect our systems and yours, we will automatically disable your webhook if it records 100+ failures within a 24-hour window. You will receive an email notification if this occurs.
\nEvery webhook delivery has a unique event.id (UUID). If your endpoint receives the same event.id more than once (due to retries or network issues), you should process it only once.
Recommended approach:
\nExtract event.id from the payload
Check if you have already processed this ID (store it in a database/cache)
\nIf already processed, return 200 OK immediately without re-processing
Otherwise, process the event and store the event.id
Must accept POST requests
Must respond with HTTP 2xx
Should process asynchronously and return 200 OK immediately
Must be accessible over HTTPS with a valid SSL certificate
\n