{"_id":"576c1dae808cf02b00d37405","link_url":"","githubsync":"","sync_unique":"","order":0,"body":"Welcome to VeriCheck's REST API! Here you will find information on how to integrate with and use the VeriCheck REST API. Please contact us at support@vericheck.net with any questions you may have regarding your integration with us!\n\nThe VeriCheck API is architected around REST, using standard HTTP verbs to communicate and HTTP response codes to indicate status and errors. All responses come in JSON. The VeriCheck API is served over HTTPS to ensure data privacy; HTTP is not supported. Every request must include your partner_id, except those sent to the Institution or Category endpoints. Request data can be included in either the body or query string, though using the body is recommended.","category":"576c1dae808cf02b00d37403","createdAt":"2015-05-28T18:46:26.970Z","api":{"params":[],"url":"","results":{"codes":[]},"settings":"","auth":"required"},"type":"basic","project":"551afaf86491a10d009994bd","user":"5567617177c15523002fd600","link_external":false,"hidden":false,"isReference":false,"excerpt":"","title":"Introduction","version":"576c1dae808cf02b00d37402","__v":2,"updates":["5d7eeb94aeb530003bb0c817"],"slug":"introduction","next":{"description":"","pages":[]},"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

Introduction


Welcome to VeriCheck's REST API! Here you will find information on how to integrate with and use the VeriCheck REST API. Please contact us at support@vericheck.net with any questions you may have regarding your integration with us! The VeriCheck API is architected around REST, using standard HTTP verbs to communicate and HTTP response codes to indicate status and errors. All responses come in JSON. The VeriCheck API is served over HTTPS to ensure data privacy; HTTP is not supported. Every request must include your partner_id, except those sent to the Institution or Category endpoints. Request data can be included in either the body or query string, though using the body is recommended.
Welcome to VeriCheck's REST API! Here you will find information on how to integrate with and use the VeriCheck REST API. Please contact us at support@vericheck.net with any questions you may have regarding your integration with us! The VeriCheck API is architected around REST, using standard HTTP verbs to communicate and HTTP response codes to indicate status and errors. All responses come in JSON. The VeriCheck API is served over HTTPS to ensure data privacy; HTTP is not supported. Every request must include your partner_id, except those sent to the Institution or Category endpoints. Request data can be included in either the body or query string, though using the body is recommended.
{"_id":"576c1dae808cf02b00d37406","isReference":false,"order":1,"excerpt":"","slug":"obtaining-credentials","category":"576c1dae808cf02b00d37403","user":"5567617177c15523002fd600","link_external":false,"hidden":false,"title":"Obtaining Credentials","__v":1,"project":"551afaf86491a10d009994bd","createdAt":"2015-05-28T18:53:25.825Z","link_url":"","githubsync":"","type":"basic","updates":[],"sync_unique":"","api":{"results":{"codes":[{"language":"json","code":"{}","name":"","status":200},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"body":"Please send credential requests to support@vericheck.net","version":"576c1dae808cf02b00d37402","next":{"description":"","pages":[]},"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

Obtaining Credentials


Please send credential requests to support@vericheck.net
Please send credential requests to support@vericheck.net
{"_id":"576c1dae808cf02b00d37407","updates":[],"createdAt":"2015-05-29T13:58:15.783Z","api":{"url":"","results":{"codes":[{"language":"json","code":"{}","name":"","status":200},{"code":"{}","name":"","status":400,"language":"json"}]},"settings":"","auth":"required","params":[]},"excerpt":"","type":"basic","title":"Sandbox","version":"576c1dae808cf02b00d37402","body":"Obtain test credentials by emailing support@vericheck.net. An api_key and test merchant will be sent out to begin testing against our API. \n\nThe api_key and merchant_id can be used to interact with our API as \"live\" credentials. This means that all communication with VeriCheck will be identical to the communication implemented when you actually move your environment into production. The credentials correspond with live accounts on the VeriCheck backend that have been created specifically for testing purposes.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Test Url\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://1d3.api.vericheck.com\",\n      \"language\": \"text\",\n      \"name\": \"Url\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Test Routing Numbers\"\n}\n[/block]\nAuthentic routing numbers must be used for creating test transactions, otherwise transactions will fail VeriCheck's routing number verification.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"061000227 - Wells Fargo (Georgia)\\n061000052 - Bank of America (Georgia)\\n061092387 - J.P Morgan Chase (Georgia)\",\n      \"language\": \"text\",\n      \"name\": \"Routing Numbers\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Test Account Numbers\"\n}\n[/block]\nBelow are a few test account numbers to use\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"Test Account Numbers\\n10102233\\n10103344\\n10104455\\n10105566\\n10106677\\n10107788\\n10108899\",\n      \"language\": \"text\",\n      \"name\": \"Account Numbers\"\n    }\n  ]\n}\n[/block]","user":"5567617177c15523002fd600","githubsync":"","sync_unique":"","order":2,"slug":"sandbox","category":"576c1dae808cf02b00d37403","project":"551afaf86491a10d009994bd","link_external":false,"link_url":"","hidden":false,"isReference":false,"__v":1,"next":{"description":"","pages":[]},"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

Sandbox


Obtain test credentials by emailing support@vericheck.net. An api_key and test merchant will be sent out to begin testing against our API. The api_key and merchant_id can be used to interact with our API as "live" credentials. This means that all communication with VeriCheck will be identical to the communication implemented when you actually move your environment into production. The credentials correspond with live accounts on the VeriCheck backend that have been created specifically for testing purposes. [block:api-header] { "type": "basic", "title": "Test Url" } [/block] [block:code] { "codes": [ { "code": "https://1d3.api.vericheck.com", "language": "text", "name": "Url" } ] } [/block] [block:api-header] { "type": "basic", "title": "Test Routing Numbers" } [/block] Authentic routing numbers must be used for creating test transactions, otherwise transactions will fail VeriCheck's routing number verification. [block:code] { "codes": [ { "code": "061000227 - Wells Fargo (Georgia)\n061000052 - Bank of America (Georgia)\n061092387 - J.P Morgan Chase (Georgia)", "language": "text", "name": "Routing Numbers" } ] } [/block] [block:api-header] { "type": "basic", "title": "Test Account Numbers" } [/block] Below are a few test account numbers to use [block:code] { "codes": [ { "code": "Test Account Numbers\n10102233\n10103344\n10104455\n10105566\n10106677\n10107788\n10108899", "language": "text", "name": "Account Numbers" } ] } [/block]
Obtain test credentials by emailing support@vericheck.net. An api_key and test merchant will be sent out to begin testing against our API. The api_key and merchant_id can be used to interact with our API as "live" credentials. This means that all communication with VeriCheck will be identical to the communication implemented when you actually move your environment into production. The credentials correspond with live accounts on the VeriCheck backend that have been created specifically for testing purposes. [block:api-header] { "type": "basic", "title": "Test Url" } [/block] [block:code] { "codes": [ { "code": "https://1d3.api.vericheck.com", "language": "text", "name": "Url" } ] } [/block] [block:api-header] { "type": "basic", "title": "Test Routing Numbers" } [/block] Authentic routing numbers must be used for creating test transactions, otherwise transactions will fail VeriCheck's routing number verification. [block:code] { "codes": [ { "code": "061000227 - Wells Fargo (Georgia)\n061000052 - Bank of America (Georgia)\n061092387 - J.P Morgan Chase (Georgia)", "language": "text", "name": "Routing Numbers" } ] } [/block] [block:api-header] { "type": "basic", "title": "Test Account Numbers" } [/block] Below are a few test account numbers to use [block:code] { "codes": [ { "code": "Test Account Numbers\n10102233\n10103344\n10104455\n10105566\n10106677\n10107788\n10108899", "language": "text", "name": "Account Numbers" } ] } [/block]
{"_id":"576c1dae808cf02b00d37408","category":"576c1dae808cf02b00d37404","hidden":false,"isReference":false,"link_url":"","slug":"authentication","title":"Authentication","__v":1,"body":"Authentication is achieved via HTTP Basic Access Authentication. The api_key must be submitted as the username, and the password must be blank.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Example\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"api_key = 210518b2f10111e3a87a5fbe08cfc8de\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl https://1d3.api.vericheck.com/merchants \\\\\\n-u api_210518b2f10111e3a87a5fbe08cfc8de:\\n… etc … etc\",\n      \"language\": \"curl\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Failed Response Example\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{  \\n   \\\"success\\\":false,\\n   \\\"message\\\":\\\"Authentication failed.\\\"\\n}\",\n      \"language\": \"text\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","updates":[],"createdAt":"2015-04-15T20:39:23.747Z","githubsync":"","link_external":false,"next":{"pages":[],"description":""},"type":"basic","api":{"auth":"required","params":[],"url":"","results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":""},"project":"551afaf86491a10d009994bd","sync_unique":"","user":"552e9946a702770d00d96e5e","excerpt":"","order":3,"version":"576c1dae808cf02b00d37402","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

Authentication


Authentication is achieved via HTTP Basic Access Authentication. The api_key must be submitted as the username, and the password must be blank. [block:api-header] { "type": "basic", "title": "Example", "sidebar": true } [/block] [block:textarea] { "text": "api_key = 210518b2f10111e3a87a5fbe08cfc8de", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "curl https://1d3.api.vericheck.com/merchants \\\n-u api_210518b2f10111e3a87a5fbe08cfc8de:\n… etc … etc", "language": "curl" } ], "sidebar": true } [/block] [block:api-header] { "type": "basic", "title": "Failed Response Example", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{ \n \"success\":false,\n \"message\":\"Authentication failed.\"\n}", "language": "text" } ], "sidebar": true } [/block]
Authentication is achieved via HTTP Basic Access Authentication. The api_key must be submitted as the username, and the password must be blank. [block:api-header] { "type": "basic", "title": "Example", "sidebar": true } [/block] [block:textarea] { "text": "api_key = 210518b2f10111e3a87a5fbe08cfc8de", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "curl https://1d3.api.vericheck.com/merchants \\\n-u api_210518b2f10111e3a87a5fbe08cfc8de:\n… etc … etc", "language": "curl" } ], "sidebar": true } [/block] [block:api-header] { "type": "basic", "title": "Failed Response Example", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{ \n \"success\":false,\n \"message\":\"Authentication failed.\"\n}", "language": "text" } ], "sidebar": true } [/block]
{"_id":"576c1dae808cf02b00d37409","link_url":"","user":"551afac3aa22ba0d001a2bbf","version":"576c1dae808cf02b00d37402","link_external":false,"project":"551afaf86491a10d009994bd","slug":"trans","type":"basic","__v":1,"api":{"params":[],"url":"","results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required"},"category":"576c1dae808cf02b00d37404","createdAt":"2015-03-31T19:52:25.622Z","next":{"description":"","pages":[]},"sync_unique":"","title":"Transactions","updates":[],"body":"Creation of an ACH draft by a merchant or customer in exchange for the products or services of a merchant. Transactions utilize the customer’s routing and account information.\n[block:html]\n{\n  \"html\": \"<br>\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"post\",\n  \"title\": \"HTTP Method: POST\"\n}\n[/block]\nUse this method to create a transaction.\n[block:html]\n{\n  \"html\": \"<br><br><br><br><br><br><br><br><br><br><br><br>\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Create Transaction\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"https://1d3.api.vericheck.com/transactions\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"post\",\n  \"title\": \"Request Content – Example #1\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{  \\n   \\\"merchant_id\\\":\\\"mer_7sdkf023jossdjf2398ald\\\",\\n   \\\"amount\\\":542.51,\\n   \\\"description\\\":\\\"Office Furniture\\\",\\n   \\\"type\\\":\\\"debit\\\",\\n   \\\"standard_entry_class\\\":\\\"PPD\\\",\\n   \\\"customer\\\":{  \\n      \\\"name\\\":\\\"Jason Smith\\\",\\n      \\\"account_number\\\":\\\"2619383845\\\",\\n      \\\"routing_number\\\":\\\"082000073\\\",\\n      \\\"account_type\\\":\\\"checking\\\"\\n   }\\n}\",\n      \"language\": \"json\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"post\",\n  \"title\": \"Request Content – Example #2\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{  \\n   \\\"merchant_id\\\":\\\"mer_7sdkf023jossdjf2398ald\\\",\\n   \\\"amount\\\":65.14,\\n   \\\"description\\\":\\\"Office Furniture\\\",\\n   \\\"type\\\":\\\"debit\\\",\\n   \\\"standard_entry_class\\\":\\\"WEB\\\",\\n   \\\"customer\\\":{  \\n      \\\"id\\\":\\\"cus_2k1620ikf0k3235gf343\\\"\\n   }\\n}\",\n      \"language\": \"json\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response Example:\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{  \\n   \\\"success\\\":true,\\n   \\\"payload\\\":{  \\n      \\\"id\\\":\\\"txn_2387jmsjm234asdf02sf2\\\"\\n   }\\n}\",\n      \"language\": \"json\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Transaction Object\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Data Type\",\n    \"h-2\": \"Required\",\n    \"0-0\": \"id\",\n    \"1-0\": \"merchant_id\",\n    \"2-0\": \"amount\",\n    \"3-0\": \"description\",\n    \"4-0\": \"type\",\n    \"5-0\": \"standard_entry_class\",\n    \"6-0\": \"check_number\",\n    \"7-0\": \"check_image_front\",\n    \"8-0\": \"check_image_back\",\n    \"9-0\": \"customer\",\n    \"0-1\": \"string\",\n    \"1-1\": \"string\",\n    \"3-1\": \"string\",\n    \"4-1\": \"string ('debit', 'credit')\",\n    \"5-1\": \"string\",\n    \"6-1\": \"string\",\n    \"2-1\": \"number\",\n    \"7-1\": \"string; base64 encoded\",\n    \"8-1\": \"string; base64 encoded\",\n    \"9-1\": \"object; either id or whole object\",\n    \"0-2\": \"no\",\n    \"1-2\": \"yes\",\n    \"2-2\": \"yes\",\n    \"3-2\": \"yes\",\n    \"4-2\": \"yes\",\n    \"5-2\": \"yes\",\n    \"9-2\": \"yes\",\n    \"6-2\": \"yes for BOC, POP\",\n    \"7-2\": \"yes for POP, ICL, BOC\",\n    \"8-2\": \"yes for POP, ICL, BOC\",\n    \"h-3\": \"Description\",\n    \"0-3\": \"transaction identifier that begins with prefix 'txn_xxxxxxxxxxx'\",\n    \"1-3\": \"unique identifier of the merchant that begins with prefix 'mer_xxxxxxxxx'\",\n    \"2-3\": \"the monetary value\",\n    \"3-3\": \"description of the transaction\",\n    \"4-3\": \"debit is  ACH transaction that is intended to\\nwithdraw funds from a Receiver’s account for deposit into\\nMerchant’s Settlement Account\\n\\ncredit is ACH transaction that is intended to\\ndeposit funds into a Receiver’s account\\nwhich has been withdrawn from Merchant’s Settlement\\nAccount.\",\n    \"5-3\": \"the standard_entry_classes are 3 character codes used to identify various types of entries. See http://www.vericheck.com/ach-transaction-types/ for more details.\",\n    \"6-3\": \"the check_number is the identifying number of a check.\",\n    \"7-3\": \"front image copy of the check associated with the account.\",\n    \"8-3\": \"back image copy of the check associated with the account.\",\n    \"9-3\": \"full customer credentials which includes name, routing number, account number, and account type or customer token that begins with prefix 'cus_xxxxxxxxxxx'.\"\n  },\n  \"cols\": 4,\n  \"rows\": 10\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"put\",\n  \"title\": \"HTTP Method: PUT\"\n}\n[/block]\nThis method is used to void or reverse transactions. \n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Void Transaction\"\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"https://1d3.api.vericheck.com/transactions/{transaction_id}/void\"\n}\n[/block]\nDoes not require a request body.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Reverse Transaction\"\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"https://1d3.api.vericheck.com/transactions/{transaction_id}/reverse\"\n}\n[/block]\nDoes not require a request body","excerpt":"","githubsync":"","hidden":false,"isReference":false,"order":4,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

Transactions


Creation of an ACH draft by a merchant or customer in exchange for the products or services of a merchant. Transactions utilize the customer’s routing and account information. [block:html] { "html": "<br>" } [/block] [block:api-header] { "type": "post", "title": "HTTP Method: POST" } [/block] Use this method to create a transaction. [block:html] { "html": "<br><br><br><br><br><br><br><br><br><br><br><br>", "sidebar": true } [/block] [block:api-header] { "type": "basic", "title": "Create Transaction", "sidebar": true } [/block] [block:html] { "html": "https://1d3.api.vericheck.com/transactions", "sidebar": true } [/block] [block:api-header] { "type": "post", "title": "Request Content – Example #1", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{ \n \"merchant_id\":\"mer_7sdkf023jossdjf2398ald\",\n \"amount\":542.51,\n \"description\":\"Office Furniture\",\n \"type\":\"debit\",\n \"standard_entry_class\":\"PPD\",\n \"customer\":{ \n \"name\":\"Jason Smith\",\n \"account_number\":\"2619383845\",\n \"routing_number\":\"082000073\",\n \"account_type\":\"checking\"\n }\n}", "language": "json" } ], "sidebar": true } [/block] [block:api-header] { "type": "post", "title": "Request Content – Example #2", "sidebar": true } [/block] [block:textarea] { "text": "", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{ \n \"merchant_id\":\"mer_7sdkf023jossdjf2398ald\",\n \"amount\":65.14,\n \"description\":\"Office Furniture\",\n \"type\":\"debit\",\n \"standard_entry_class\":\"WEB\",\n \"customer\":{ \n \"id\":\"cus_2k1620ikf0k3235gf343\"\n }\n}", "language": "json" } ], "sidebar": true } [/block] [block:api-header] { "type": "basic", "title": "Response Example:", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{ \n \"success\":true,\n \"payload\":{ \n \"id\":\"txn_2387jmsjm234asdf02sf2\"\n }\n}", "language": "json" } ], "sidebar": true } [/block] [block:api-header] { "type": "basic", "title": "Transaction Object" } [/block] [block:parameters] { "data": { "h-0": "Field", "h-1": "Data Type", "h-2": "Required", "0-0": "id", "1-0": "merchant_id", "2-0": "amount", "3-0": "description", "4-0": "type", "5-0": "standard_entry_class", "6-0": "check_number", "7-0": "check_image_front", "8-0": "check_image_back", "9-0": "customer", "0-1": "string", "1-1": "string", "3-1": "string", "4-1": "string ('debit', 'credit')", "5-1": "string", "6-1": "string", "2-1": "number", "7-1": "string; base64 encoded", "8-1": "string; base64 encoded", "9-1": "object; either id or whole object", "0-2": "no", "1-2": "yes", "2-2": "yes", "3-2": "yes", "4-2": "yes", "5-2": "yes", "9-2": "yes", "6-2": "yes for BOC, POP", "7-2": "yes for POP, ICL, BOC", "8-2": "yes for POP, ICL, BOC", "h-3": "Description", "0-3": "transaction identifier that begins with prefix 'txn_xxxxxxxxxxx'", "1-3": "unique identifier of the merchant that begins with prefix 'mer_xxxxxxxxx'", "2-3": "the monetary value", "3-3": "description of the transaction", "4-3": "debit is ACH transaction that is intended to\nwithdraw funds from a Receiver’s account for deposit into\nMerchant’s Settlement Account\n\ncredit is ACH transaction that is intended to\ndeposit funds into a Receiver’s account\nwhich has been withdrawn from Merchant’s Settlement\nAccount.", "5-3": "the standard_entry_classes are 3 character codes used to identify various types of entries. See http://www.vericheck.com/ach-transaction-types/ for more details.", "6-3": "the check_number is the identifying number of a check.", "7-3": "front image copy of the check associated with the account.", "8-3": "back image copy of the check associated with the account.", "9-3": "full customer credentials which includes name, routing number, account number, and account type or customer token that begins with prefix 'cus_xxxxxxxxxxx'." }, "cols": 4, "rows": 10 } [/block] [block:api-header] { "type": "put", "title": "HTTP Method: PUT" } [/block] This method is used to void or reverse transactions. [block:api-header] { "type": "basic", "title": "Void Transaction" } [/block] [block:html] { "html": "https://1d3.api.vericheck.com/transactions/{transaction_id}/void" } [/block] Does not require a request body. [block:api-header] { "type": "basic", "title": "Reverse Transaction" } [/block] [block:html] { "html": "https://1d3.api.vericheck.com/transactions/{transaction_id}/reverse" } [/block] Does not require a request body
Creation of an ACH draft by a merchant or customer in exchange for the products or services of a merchant. Transactions utilize the customer’s routing and account information. [block:html] { "html": "<br>" } [/block] [block:api-header] { "type": "post", "title": "HTTP Method: POST" } [/block] Use this method to create a transaction. [block:html] { "html": "<br><br><br><br><br><br><br><br><br><br><br><br>", "sidebar": true } [/block] [block:api-header] { "type": "basic", "title": "Create Transaction", "sidebar": true } [/block] [block:html] { "html": "https://1d3.api.vericheck.com/transactions", "sidebar": true } [/block] [block:api-header] { "type": "post", "title": "Request Content – Example #1", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{ \n \"merchant_id\":\"mer_7sdkf023jossdjf2398ald\",\n \"amount\":542.51,\n \"description\":\"Office Furniture\",\n \"type\":\"debit\",\n \"standard_entry_class\":\"PPD\",\n \"customer\":{ \n \"name\":\"Jason Smith\",\n \"account_number\":\"2619383845\",\n \"routing_number\":\"082000073\",\n \"account_type\":\"checking\"\n }\n}", "language": "json" } ], "sidebar": true } [/block] [block:api-header] { "type": "post", "title": "Request Content – Example #2", "sidebar": true } [/block] [block:textarea] { "text": "", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{ \n \"merchant_id\":\"mer_7sdkf023jossdjf2398ald\",\n \"amount\":65.14,\n \"description\":\"Office Furniture\",\n \"type\":\"debit\",\n \"standard_entry_class\":\"WEB\",\n \"customer\":{ \n \"id\":\"cus_2k1620ikf0k3235gf343\"\n }\n}", "language": "json" } ], "sidebar": true } [/block] [block:api-header] { "type": "basic", "title": "Response Example:", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{ \n \"success\":true,\n \"payload\":{ \n \"id\":\"txn_2387jmsjm234asdf02sf2\"\n }\n}", "language": "json" } ], "sidebar": true } [/block] [block:api-header] { "type": "basic", "title": "Transaction Object" } [/block] [block:parameters] { "data": { "h-0": "Field", "h-1": "Data Type", "h-2": "Required", "0-0": "id", "1-0": "merchant_id", "2-0": "amount", "3-0": "description", "4-0": "type", "5-0": "standard_entry_class", "6-0": "check_number", "7-0": "check_image_front", "8-0": "check_image_back", "9-0": "customer", "0-1": "string", "1-1": "string", "3-1": "string", "4-1": "string ('debit', 'credit')", "5-1": "string", "6-1": "string", "2-1": "number", "7-1": "string; base64 encoded", "8-1": "string; base64 encoded", "9-1": "object; either id or whole object", "0-2": "no", "1-2": "yes", "2-2": "yes", "3-2": "yes", "4-2": "yes", "5-2": "yes", "9-2": "yes", "6-2": "yes for BOC, POP", "7-2": "yes for POP, ICL, BOC", "8-2": "yes for POP, ICL, BOC", "h-3": "Description", "0-3": "transaction identifier that begins with prefix 'txn_xxxxxxxxxxx'", "1-3": "unique identifier of the merchant that begins with prefix 'mer_xxxxxxxxx'", "2-3": "the monetary value", "3-3": "description of the transaction", "4-3": "debit is ACH transaction that is intended to\nwithdraw funds from a Receiver’s account for deposit into\nMerchant’s Settlement Account\n\ncredit is ACH transaction that is intended to\ndeposit funds into a Receiver’s account\nwhich has been withdrawn from Merchant’s Settlement\nAccount.", "5-3": "the standard_entry_classes are 3 character codes used to identify various types of entries. See http://www.vericheck.com/ach-transaction-types/ for more details.", "6-3": "the check_number is the identifying number of a check.", "7-3": "front image copy of the check associated with the account.", "8-3": "back image copy of the check associated with the account.", "9-3": "full customer credentials which includes name, routing number, account number, and account type or customer token that begins with prefix 'cus_xxxxxxxxxxx'." }, "cols": 4, "rows": 10 } [/block] [block:api-header] { "type": "put", "title": "HTTP Method: PUT" } [/block] This method is used to void or reverse transactions. [block:api-header] { "type": "basic", "title": "Void Transaction" } [/block] [block:html] { "html": "https://1d3.api.vericheck.com/transactions/{transaction_id}/void" } [/block] Does not require a request body. [block:api-header] { "type": "basic", "title": "Reverse Transaction" } [/block] [block:html] { "html": "https://1d3.api.vericheck.com/transactions/{transaction_id}/reverse" } [/block] Does not require a request body
{"_id":"576c1dae808cf02b00d3740a","__v":1,"body":"Customers are consumers of products or services. Customers can be created and their payment information securely stored for the creation of transactions.\n[block:html]\n{\n  \"html\": \"<br><br><br><br><br><br><br><br><br><br><br><br>\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<br>\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"post\",\n  \"title\": \"HTTP Method: POST\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"URL\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"https://1d3.api.vericheck.com/customers\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Request Content – Example #1\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n   \\\"merchant_id\\\":\\\"mer_7sdkf023jossdjf2398ald\\\",  \\n   \\\"name\\\":\\\"Amy Grant\\\",\\n   \\\"routing_number\\\":\\\"021100361\\\",\\n   \\\"account_number\\\":\\\"54846541235\\\",\\n   \\\"account_type\\\":\\\"checking\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Request Content – Example #2\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n   \\\"merchant_id\\\":\\\"global\\\",  \\n   \\\"name\\\":\\\"Clint\\tPatton\\\",\\n   \\\"routing_number\\\":\\\"021100361\\\",\\n   \\\"account_number\\\":\\\"54654644\\\",\\n   \\\"account_type\\\":\\\"savings\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response Example\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{  \\n   \\\"success\\\":\\\"true\\\",\\n   \\\"payload\\\":{  \\n      \\\"id\\\":\\\"cus_634kljSAF23oijjfoesdlfmFe2\\\"\\n   }\\n}\",\n      \"language\": \"json\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Customer Object\"\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<br><br><br><br><br><br>\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"URL\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"https://1d3.api.vericheck.com/customers/[TOKEN]\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Request Content – Example\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"https://1d3.api.vericheck.com/customers/cus_634kljSAF23oijjfoesdlfmFe2\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response Example:\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\\"success\\\":\\\"true\\\"}\",\n      \"language\": \"json\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Data Type\",\n    \"h-2\": \"Required\",\n    \"0-0\": \"id\",\n    \"3-0\": \"routing_number\",\n    \"4-0\": \"account_number\",\n    \"0-1\": \"string\",\n    \"3-1\": \"string\",\n    \"4-1\": \"string\",\n    \"0-2\": \"no\",\n    \"3-2\": \"yes\",\n    \"4-2\": \"yes\",\n    \"2-0\": \"name\",\n    \"2-1\": \"string\",\n    \"2-2\": \"yes\",\n    \"1-0\": \"merchant_id\",\n    \"1-1\": \"string\",\n    \"1-2\": \"yes\",\n    \"5-0\": \"account_type\",\n    \"5-1\": \"string\",\n    \"5-2\": \"yes\",\n    \"h-3\": \"Description\",\n    \"0-3\": \"customer token that begins with prefix 'cus_xxxxxxxxxxx'\",\n    \"1-3\": \"unique identifier of the merchant that begins with prefix 'mer_xxxxxxxxx' or 'global' for customer being utilized by multiple merchants\",\n    \"2-3\": \"name of the customer\",\n    \"3-3\": \"bank routing number\",\n    \"4-3\": \"bank account number\",\n    \"5-3\": \"'checking' or 'savings'\"\n  },\n  \"cols\": 4,\n  \"rows\": 6\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<br><br><br><br><br><br><br><br><br><br><br><br>\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"delete\",\n  \"title\": \"HTTP Method: DELETE\"\n}\n[/block]","category":"576c1dae808cf02b00d37404","slug":"customers","hidden":false,"next":{"description":"","pages":[]},"sync_unique":"","title":"Customers","link_url":"","project":"551afaf86491a10d009994bd","type":"basic","updates":[],"createdAt":"2015-04-15T20:41:16.520Z","excerpt":"","githubsync":"","user":"552e9946a702770d00d96e5e","version":"576c1dae808cf02b00d37402","api":{"auth":"required","params":[],"url":"","results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":""},"isReference":false,"link_external":false,"order":5,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

Customers


Customers are consumers of products or services. Customers can be created and their payment information securely stored for the creation of transactions. [block:html] { "html": "<br><br><br><br><br><br><br><br><br><br><br><br>", "sidebar": true } [/block] [block:html] { "html": "<br>" } [/block] [block:api-header] { "type": "post", "title": "HTTP Method: POST" } [/block] [block:api-header] { "type": "basic", "title": "URL", "sidebar": true } [/block] [block:html] { "html": "https://1d3.api.vericheck.com/customers", "sidebar": true } [/block] [block:api-header] { "type": "basic", "title": "Request Content – Example #1", "sidebar": true } [/block] [block:textarea] { "text": "", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"merchant_id\":\"mer_7sdkf023jossdjf2398ald\", \n \"name\":\"Amy Grant\",\n \"routing_number\":\"021100361\",\n \"account_number\":\"54846541235\",\n \"account_type\":\"checking\"\n}", "language": "json" } ], "sidebar": true } [/block] [block:api-header] { "type": "basic", "title": "Request Content – Example #2", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"merchant_id\":\"global\", \n \"name\":\"Clint\tPatton\",\n \"routing_number\":\"021100361\",\n \"account_number\":\"54654644\",\n \"account_type\":\"savings\"\n}", "language": "json" } ], "sidebar": true } [/block] [block:api-header] { "type": "basic", "title": "Response Example", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{ \n \"success\":\"true\",\n \"payload\":{ \n \"id\":\"cus_634kljSAF23oijjfoesdlfmFe2\"\n }\n}", "language": "json" } ], "sidebar": true } [/block] [block:api-header] { "type": "basic", "title": "Customer Object" } [/block] [block:html] { "html": "<br><br><br><br><br><br>", "sidebar": true } [/block] [block:api-header] { "type": "basic", "title": "URL", "sidebar": true } [/block] [block:html] { "html": "https://1d3.api.vericheck.com/customers/[TOKEN]", "sidebar": true } [/block] [block:api-header] { "type": "basic", "title": "Request Content – Example", "sidebar": true } [/block] [block:html] { "html": "https://1d3.api.vericheck.com/customers/cus_634kljSAF23oijjfoesdlfmFe2", "sidebar": true } [/block] [block:api-header] { "type": "basic", "title": "Response Example:", "sidebar": true } [/block] [block:textarea] { "text": "", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\"success\":\"true\"}", "language": "json" } ], "sidebar": true } [/block] [block:parameters] { "data": { "h-0": "Field", "h-1": "Data Type", "h-2": "Required", "0-0": "id", "3-0": "routing_number", "4-0": "account_number", "0-1": "string", "3-1": "string", "4-1": "string", "0-2": "no", "3-2": "yes", "4-2": "yes", "2-0": "name", "2-1": "string", "2-2": "yes", "1-0": "merchant_id", "1-1": "string", "1-2": "yes", "5-0": "account_type", "5-1": "string", "5-2": "yes", "h-3": "Description", "0-3": "customer token that begins with prefix 'cus_xxxxxxxxxxx'", "1-3": "unique identifier of the merchant that begins with prefix 'mer_xxxxxxxxx' or 'global' for customer being utilized by multiple merchants", "2-3": "name of the customer", "3-3": "bank routing number", "4-3": "bank account number", "5-3": "'checking' or 'savings'" }, "cols": 4, "rows": 6 } [/block] [block:html] { "html": "<br><br><br><br><br><br><br><br><br><br><br><br>" } [/block] [block:api-header] { "type": "delete", "title": "HTTP Method: DELETE" } [/block]
Customers are consumers of products or services. Customers can be created and their payment information securely stored for the creation of transactions. [block:html] { "html": "<br><br><br><br><br><br><br><br><br><br><br><br>", "sidebar": true } [/block] [block:html] { "html": "<br>" } [/block] [block:api-header] { "type": "post", "title": "HTTP Method: POST" } [/block] [block:api-header] { "type": "basic", "title": "URL", "sidebar": true } [/block] [block:html] { "html": "https://1d3.api.vericheck.com/customers", "sidebar": true } [/block] [block:api-header] { "type": "basic", "title": "Request Content – Example #1", "sidebar": true } [/block] [block:textarea] { "text": "", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"merchant_id\":\"mer_7sdkf023jossdjf2398ald\", \n \"name\":\"Amy Grant\",\n \"routing_number\":\"021100361\",\n \"account_number\":\"54846541235\",\n \"account_type\":\"checking\"\n}", "language": "json" } ], "sidebar": true } [/block] [block:api-header] { "type": "basic", "title": "Request Content – Example #2", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"merchant_id\":\"global\", \n \"name\":\"Clint\tPatton\",\n \"routing_number\":\"021100361\",\n \"account_number\":\"54654644\",\n \"account_type\":\"savings\"\n}", "language": "json" } ], "sidebar": true } [/block] [block:api-header] { "type": "basic", "title": "Response Example", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{ \n \"success\":\"true\",\n \"payload\":{ \n \"id\":\"cus_634kljSAF23oijjfoesdlfmFe2\"\n }\n}", "language": "json" } ], "sidebar": true } [/block] [block:api-header] { "type": "basic", "title": "Customer Object" } [/block] [block:html] { "html": "<br><br><br><br><br><br>", "sidebar": true } [/block] [block:api-header] { "type": "basic", "title": "URL", "sidebar": true } [/block] [block:html] { "html": "https://1d3.api.vericheck.com/customers/[TOKEN]", "sidebar": true } [/block] [block:api-header] { "type": "basic", "title": "Request Content – Example", "sidebar": true } [/block] [block:html] { "html": "https://1d3.api.vericheck.com/customers/cus_634kljSAF23oijjfoesdlfmFe2", "sidebar": true } [/block] [block:api-header] { "type": "basic", "title": "Response Example:", "sidebar": true } [/block] [block:textarea] { "text": "", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\"success\":\"true\"}", "language": "json" } ], "sidebar": true } [/block] [block:parameters] { "data": { "h-0": "Field", "h-1": "Data Type", "h-2": "Required", "0-0": "id", "3-0": "routing_number", "4-0": "account_number", "0-1": "string", "3-1": "string", "4-1": "string", "0-2": "no", "3-2": "yes", "4-2": "yes", "2-0": "name", "2-1": "string", "2-2": "yes", "1-0": "merchant_id", "1-1": "string", "1-2": "yes", "5-0": "account_type", "5-1": "string", "5-2": "yes", "h-3": "Description", "0-3": "customer token that begins with prefix 'cus_xxxxxxxxxxx'", "1-3": "unique identifier of the merchant that begins with prefix 'mer_xxxxxxxxx' or 'global' for customer being utilized by multiple merchants", "2-3": "name of the customer", "3-3": "bank routing number", "4-3": "bank account number", "5-3": "'checking' or 'savings'" }, "cols": 4, "rows": 6 } [/block] [block:html] { "html": "<br><br><br><br><br><br><br><br><br><br><br><br>" } [/block] [block:api-header] { "type": "delete", "title": "HTTP Method: DELETE" } [/block]
{"_id":"576c1dae808cf02b00d3740c","api":{"auth":"required","params":[],"url":"","results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":""},"body":"Status Changes occur periodically through the life-cycle of a transaction. They represent different states of a transaction as it progresses through VeriCheck and into the ACH network.\n\nVeriCheck Transaction Statuses\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Transaction Status\",\n    \"h-1\": \"Status Name\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"A\",\n    \"0-1\": \"Pending\",\n    \"0-2\": \"The transaction has been initiated and accepted for processing by VeriCheck.\\n\\nTransactions can be voided while in 'Pending' status. \\n\\nTransactions automatically change from 'Pending' status at 6PM Eastern Time.\",\n    \"1-0\": \"B\",\n    \"1-1\": \"Originated\",\n    \"1-2\": \"Transaction has been pulled from the system for processing through the Federal Reserve.\\n\\nTransaction may not be reversed or voided in this state\",\n    \"2-0\": \"R\",\n    \"2-1\": \"Returned\",\n    \"2-2\": \"Transaction has been returned by the customer's bank.\\n\\nFor more information on types and reasons for returns, see: http://www.vericheck.com/ach-return-codes/\",\n    \"3-0\": \"S\",\n    \"3-1\": \"Settled\",\n    \"3-2\": \"Transaction has been funded to the Merchant's Bank.\\n\\nTransaction can be reversed/refunded in this state\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<br>\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"get\",\n  \"title\": \"HTTP Method: GET\"\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"URL\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"https://1d3.api.vericheck.com/status-changes/{last_pointer}\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Example\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"https://1d3.api.vericheck.com/status-changes/3445e364de5211e3b1f283643dd2149d\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response Example\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{  \\n   \\\"success\\\":\\\"true\\\",\\n   \\\"payload\\\":{  \\n      \\\"new_pointer\\\":\\\"910789f0de5611e38e1597ecceaf7483\\\",\\n      \\\"changes\\\":[  \\n         {  \\n            \\\"transaction_id\\\":\\\"txn_f2nj9c2n9823onf28nf98n2c2hj2c32\\\",\\n            \\\"change_timestamp\\\":\\\"2014-05-08 12:24:30\\\",\\n            \\\"origination_date\\\":\\\"2014-05-05\\\",\\n            \\\"effective_date\\\":\\\"2014-05-06\\\",\\n            \\\"settlement_date\\\":\\\"2014-05-07\\\",\\n            \\\"return_date\\\":\\\"2014-05-08\\\",\\n            \\\"return_code\\\":\\\"R01\\\",\\n            \\\"status\\\":\\\"R\\\",\\n            \\\"reason\\\":\\\"Insufficient funds.\\\"\\n         },\\n         {  \\n            \\\"transaction_id\\\":\\\"txn_7bbb7eaade5911e3852f9fab4e2ed2b4\\\",\\n            \\\"change_timestamp\\\":\\\"2014-04-11 12:14:10\\\",\\n            \\\"origination_date\\\":\\\"2014-04-08\\\",\\n            \\\"effective_date\\\":\\\"2014-04-09\\\",\\n            \\\"settlement_date\\\":\\\"2014-04-11\\\",\\n            \\\"return_date\\\":null,\\n            \\\"return_code\\\":null,\\n            \\\"status\\\":\\\"S\\\",\\n            \\\"reason\\\":null\\n         },\\n         {  \\n            \\\"transaction_id\\\":\\\"txn_jc238j9jij230j0238fj283jf2323r2\\\",\\n            \\\"change_timestamp\\\":\\\"2014-03-18 10:44:50\\\",\\n            \\\"origination_date\\\":\\\"2014-03-17\\\",\\n            \\\"effective_date\\\":\\\"2014-03-18\\\",\\n            \\\"settlement_date\\\":null,\\n            \\\"return_date\\\":\\\"2014-03-18\\\",\\n            \\\"return_code\\\":\\\"R16\\\",\\n            \\\"status\\\":\\\"R\\\",\\n            \\\"reason\\\":\\\"Account Frozen\\\"\\n         }\\n      ]\\n   }\\n}\",\n      \"language\": \"json\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Status Change Object\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Data Type\",\n    \"0-0\": \"transaction_id\",\n    \"1-0\": \"change_timestamp\",\n    \"2-0\": \"origination_date\",\n    \"3-0\": \"effective_date\",\n    \"4-0\": \"settlement_date\",\n    \"5-0\": \"return_date\",\n    \"6-0\": \"return_code\",\n    \"7-0\": \"status\",\n    \"8-0\": \"reason\",\n    \"0-1\": \"String\",\n    \"1-1\": \"String\",\n    \"2-1\": \"String or null\",\n    \"3-1\": \"String or null\",\n    \"4-1\": \"String or null\",\n    \"5-1\": \"String or null\",\n    \"6-1\": \"String or null\",\n    \"8-1\": \"String or null\",\n    \"7-1\": \"String (‘A’, ‘B’, ‘S’, ‘R’)\"\n  },\n  \"cols\": 2,\n  \"rows\": 9\n}\n[/block]","hidden":false,"isReference":false,"link_external":false,"next":{"description":"","pages":[]},"order":7,"project":"551afaf86491a10d009994bd","updates":[],"user":"552e9946a702770d00d96e5e","createdAt":"2015-04-16T20:24:12.925Z","githubsync":"","link_url":"","slug":"status-changes","sync_unique":"","title":"Status Changes","__v":1,"category":"576c1dae808cf02b00d37404","excerpt":"","type":"basic","version":"576c1dae808cf02b00d37402","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

Status Changes


Status Changes occur periodically through the life-cycle of a transaction. They represent different states of a transaction as it progresses through VeriCheck and into the ACH network. VeriCheck Transaction Statuses [block:parameters] { "data": { "h-0": "Transaction Status", "h-1": "Status Name", "h-2": "Description", "0-0": "A", "0-1": "Pending", "0-2": "The transaction has been initiated and accepted for processing by VeriCheck.\n\nTransactions can be voided while in 'Pending' status. \n\nTransactions automatically change from 'Pending' status at 6PM Eastern Time.", "1-0": "B", "1-1": "Originated", "1-2": "Transaction has been pulled from the system for processing through the Federal Reserve.\n\nTransaction may not be reversed or voided in this state", "2-0": "R", "2-1": "Returned", "2-2": "Transaction has been returned by the customer's bank.\n\nFor more information on types and reasons for returns, see: http://www.vericheck.com/ach-return-codes/", "3-0": "S", "3-1": "Settled", "3-2": "Transaction has been funded to the Merchant's Bank.\n\nTransaction can be reversed/refunded in this state" }, "cols": 3, "rows": 4 } [/block] [block:html] { "html": "<br>" } [/block] [block:api-header] { "type": "get", "title": "HTTP Method: GET" } [/block] [block:html] { "html": "<br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>", "sidebar": true } [/block] [block:api-header] { "type": "basic", "title": "URL", "sidebar": true } [/block] [block:html] { "html": "https://1d3.api.vericheck.com/status-changes/{last_pointer}", "sidebar": true } [/block] [block:api-header] { "type": "basic", "title": "Example", "sidebar": true } [/block] [block:html] { "html": "https://1d3.api.vericheck.com/status-changes/3445e364de5211e3b1f283643dd2149d", "sidebar": true } [/block] [block:api-header] { "type": "basic", "title": "Response Example", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{ \n \"success\":\"true\",\n \"payload\":{ \n \"new_pointer\":\"910789f0de5611e38e1597ecceaf7483\",\n \"changes\":[ \n { \n \"transaction_id\":\"txn_f2nj9c2n9823onf28nf98n2c2hj2c32\",\n \"change_timestamp\":\"2014-05-08 12:24:30\",\n \"origination_date\":\"2014-05-05\",\n \"effective_date\":\"2014-05-06\",\n \"settlement_date\":\"2014-05-07\",\n \"return_date\":\"2014-05-08\",\n \"return_code\":\"R01\",\n \"status\":\"R\",\n \"reason\":\"Insufficient funds.\"\n },\n { \n \"transaction_id\":\"txn_7bbb7eaade5911e3852f9fab4e2ed2b4\",\n \"change_timestamp\":\"2014-04-11 12:14:10\",\n \"origination_date\":\"2014-04-08\",\n \"effective_date\":\"2014-04-09\",\n \"settlement_date\":\"2014-04-11\",\n \"return_date\":null,\n \"return_code\":null,\n \"status\":\"S\",\n \"reason\":null\n },\n { \n \"transaction_id\":\"txn_jc238j9jij230j0238fj283jf2323r2\",\n \"change_timestamp\":\"2014-03-18 10:44:50\",\n \"origination_date\":\"2014-03-17\",\n \"effective_date\":\"2014-03-18\",\n \"settlement_date\":null,\n \"return_date\":\"2014-03-18\",\n \"return_code\":\"R16\",\n \"status\":\"R\",\n \"reason\":\"Account Frozen\"\n }\n ]\n }\n}", "language": "json" } ], "sidebar": true } [/block] [block:api-header] { "type": "basic", "title": "Status Change Object" } [/block] [block:parameters] { "data": { "h-0": "Field", "h-1": "Data Type", "0-0": "transaction_id", "1-0": "change_timestamp", "2-0": "origination_date", "3-0": "effective_date", "4-0": "settlement_date", "5-0": "return_date", "6-0": "return_code", "7-0": "status", "8-0": "reason", "0-1": "String", "1-1": "String", "2-1": "String or null", "3-1": "String or null", "4-1": "String or null", "5-1": "String or null", "6-1": "String or null", "8-1": "String or null", "7-1": "String (‘A’, ‘B’, ‘S’, ‘R’)" }, "cols": 2, "rows": 9 } [/block]
Status Changes occur periodically through the life-cycle of a transaction. They represent different states of a transaction as it progresses through VeriCheck and into the ACH network. VeriCheck Transaction Statuses [block:parameters] { "data": { "h-0": "Transaction Status", "h-1": "Status Name", "h-2": "Description", "0-0": "A", "0-1": "Pending", "0-2": "The transaction has been initiated and accepted for processing by VeriCheck.\n\nTransactions can be voided while in 'Pending' status. \n\nTransactions automatically change from 'Pending' status at 6PM Eastern Time.", "1-0": "B", "1-1": "Originated", "1-2": "Transaction has been pulled from the system for processing through the Federal Reserve.\n\nTransaction may not be reversed or voided in this state", "2-0": "R", "2-1": "Returned", "2-2": "Transaction has been returned by the customer's bank.\n\nFor more information on types and reasons for returns, see: http://www.vericheck.com/ach-return-codes/", "3-0": "S", "3-1": "Settled", "3-2": "Transaction has been funded to the Merchant's Bank.\n\nTransaction can be reversed/refunded in this state" }, "cols": 3, "rows": 4 } [/block] [block:html] { "html": "<br>" } [/block] [block:api-header] { "type": "get", "title": "HTTP Method: GET" } [/block] [block:html] { "html": "<br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>", "sidebar": true } [/block] [block:api-header] { "type": "basic", "title": "URL", "sidebar": true } [/block] [block:html] { "html": "https://1d3.api.vericheck.com/status-changes/{last_pointer}", "sidebar": true } [/block] [block:api-header] { "type": "basic", "title": "Example", "sidebar": true } [/block] [block:html] { "html": "https://1d3.api.vericheck.com/status-changes/3445e364de5211e3b1f283643dd2149d", "sidebar": true } [/block] [block:api-header] { "type": "basic", "title": "Response Example", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{ \n \"success\":\"true\",\n \"payload\":{ \n \"new_pointer\":\"910789f0de5611e38e1597ecceaf7483\",\n \"changes\":[ \n { \n \"transaction_id\":\"txn_f2nj9c2n9823onf28nf98n2c2hj2c32\",\n \"change_timestamp\":\"2014-05-08 12:24:30\",\n \"origination_date\":\"2014-05-05\",\n \"effective_date\":\"2014-05-06\",\n \"settlement_date\":\"2014-05-07\",\n \"return_date\":\"2014-05-08\",\n \"return_code\":\"R01\",\n \"status\":\"R\",\n \"reason\":\"Insufficient funds.\"\n },\n { \n \"transaction_id\":\"txn_7bbb7eaade5911e3852f9fab4e2ed2b4\",\n \"change_timestamp\":\"2014-04-11 12:14:10\",\n \"origination_date\":\"2014-04-08\",\n \"effective_date\":\"2014-04-09\",\n \"settlement_date\":\"2014-04-11\",\n \"return_date\":null,\n \"return_code\":null,\n \"status\":\"S\",\n \"reason\":null\n },\n { \n \"transaction_id\":\"txn_jc238j9jij230j0238fj283jf2323r2\",\n \"change_timestamp\":\"2014-03-18 10:44:50\",\n \"origination_date\":\"2014-03-17\",\n \"effective_date\":\"2014-03-18\",\n \"settlement_date\":null,\n \"return_date\":\"2014-03-18\",\n \"return_code\":\"R16\",\n \"status\":\"R\",\n \"reason\":\"Account Frozen\"\n }\n ]\n }\n}", "language": "json" } ], "sidebar": true } [/block] [block:api-header] { "type": "basic", "title": "Status Change Object" } [/block] [block:parameters] { "data": { "h-0": "Field", "h-1": "Data Type", "0-0": "transaction_id", "1-0": "change_timestamp", "2-0": "origination_date", "3-0": "effective_date", "4-0": "settlement_date", "5-0": "return_date", "6-0": "return_code", "7-0": "status", "8-0": "reason", "0-1": "String", "1-1": "String", "2-1": "String or null", "3-1": "String or null", "4-1": "String or null", "5-1": "String or null", "6-1": "String or null", "8-1": "String or null", "7-1": "String (‘A’, ‘B’, ‘S’, ‘R’)" }, "cols": 2, "rows": 9 } [/block]
{"_id":"576c1dae808cf02b00d3740f","__v":0,"version":"576c1dae808cf02b00d37402","slug":"response","user":"552e9946a702770d00d96e5e","updates":[],"sync_unique":"","api":{"settings":"","auth":"required","params":[],"url":"","results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]}},"body":"The Response object indicates the success of the request and may contain relevant payload data.\n[block:html]\n{\n  \"html\": \"<br>\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response Object\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Data Type\",\n    \"0-0\": \"success\",\n    \"1-0\": \"message\",\n    \"2-0\": \"payload\",\n    \"0-1\": \"boolean\",\n    \"1-1\": \"string\",\n    \"2-1\": \"object\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<br><br><br><br><br><br><br>\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Examples\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{  \\n   \\\"success\\\":true,\\n   \\\"payload\\\":{  \\n      \\\"id\\\":\\\"txn_2387jmsjm234asdf02sf2\\\"\\n   }\\n}\",\n      \"language\": \"json\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{  \\n   \\\"success\\\":false,\\n   \\\"message\\\":\\\"Authentication failed.\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Error Codes\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"E\",\n    \"0-1\": \"The system is unable to process your transaction at this time\",\n    \"1-1\": \"This transaction has already been submitted for processing\",\n    \"1-0\": \"E\",\n    \"2-1\": \"Valid Referring ID or approved Credit PIN Required\",\n    \"2-0\": \"E\",\n    \"3-1\": \"This credit has been submitted\",\n    \"4-1\": \"The original transaction has already been reversed with transaction ID\",\n    \"5-1\": \"The reversal for transaction  has been submitted\",\n    \"6-1\": \"The database is currently unavailable\",\n    \"7-1\": \"Check Number Required For {TRANSACTION_TYPE} Transactions\",\n    \"8-1\": \"State Required For POP Transactions\",\n    \"9-1\": \"Failed to accept this transaction\",\n    \"3-0\": \"E\",\n    \"4-0\": \"E\",\n    \"5-0\": \"E\",\n    \"6-0\": \"E\",\n    \"7-0\": \"E\",\n    \"8-0\": \"E\",\n    \"9-0\": \"E\",\n    \"10-0\": \"E\",\n    \"10-1\": \"'{MERCHANT_ID}' is an invalid Merchant ID\",\n    \"11-1\": \"'{ROUTING_NUMBER}' is an invalid Routing Number\",\n    \"12-1\": \"'{ACCOUNT_NUMBER}' is an invalid Account Number\",\n    \"13-1\": \"'{AMOUNT}' is an invalid Amount\",\n    \"14-1\": \"Credits are limited to 50,000,000 USD\",\n    \"15-1\": \"Routing Number '{ROUTING_NUMBER}' was not found\",\n    \"16-1\": \"This is a duplicate transaction\",\n    \"17-1\": \"Duplicate transaction for this check. Check number: {CHECK_NUMBER}\",\n    \"18-0\": \"E\",\n    \"18-1\": \"Credit amount is over the maximum\",\n    \"11-0\": \"E\",\n    \"12-0\": \"E\",\n    \"13-0\": \"E\",\n    \"14-0\": \"E\",\n    \"15-0\": \"E\",\n    \"16-0\": \"E\",\n    \"17-0\": \"E\",\n    \"19-1\": \"Unable to accept {TRANSACTION_TYPE} transactions for this merchant\",\n    \"20-1\": \"Exceeded maximum dollar amount (${AMOUNT_LIMIT}) for this merchant.\",\n    \"21-1\": \"You have exceeded the allowed max daily num checks for this merchant\",\n    \"22-1\": \"You have exceeded your allowed max dollar amount for this merchant of\",\n    \"23-1\": \"You have exceeded the allowed max daily num checks overall\",\n    \"24-1\": \"You have exceeded your allowed max dollar amount overall of\",\n    \"25-1\": \"You have exceeded the maximum number of checks for this merchant this period\",\n    \"26-1\": \"You have exceeded the maximum dollar amount for this merchant this period\",\n    \"27-1\": \"You have exceeded the maximum number of checks overall this period\",\n    \"28-1\": \"You have exceeded the maximum dollar amount overall this period\",\n    \"29-1\": \"You have exceeded your monthly transaction volume\",\n    \"30-1\": \"You have exceeded your monthly dollar amount cap\",\n    \"31-1\": \"This transaction brings your monthly dollar amount over the maximum average amount allowed\",\n    \"19-0\": \"E\",\n    \"20-0\": \"E\",\n    \"21-0\": \"E\",\n    \"22-0\": \"E\",\n    \"23-0\": \"E\",\n    \"24-0\": \"E\",\n    \"25-0\": \"E\",\n    \"26-0\": \"E\",\n    \"27-0\": \"E\",\n    \"28-0\": \"E\",\n    \"29-0\": \"E\",\n    \"30-0\": \"E\",\n    \"31-0\": \"E\",\n    \"h-1\": \"Error Message\",\n    \"h-0\": \"Error Type\"\n  },\n  \"cols\": 2,\n  \"rows\": 32\n}\n[/block]","category":"576c1dae808cf02b00d37404","project":"551afaf86491a10d009994bd","type":"basic","excerpt":"","title":"Response","hidden":false,"isReference":false,"link_url":"","githubsync":"","order":10,"createdAt":"2015-04-16T21:25:32.211Z","link_external":false,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

Response


The Response object indicates the success of the request and may contain relevant payload data. [block:html] { "html": "<br>" } [/block] [block:api-header] { "type": "basic", "title": "Response Object" } [/block] [block:parameters] { "data": { "h-0": "Field", "h-1": "Data Type", "0-0": "success", "1-0": "message", "2-0": "payload", "0-1": "boolean", "1-1": "string", "2-1": "object" }, "cols": 3, "rows": 3 } [/block] [block:html] { "html": "<br><br><br><br><br><br><br>", "sidebar": true } [/block] [block:api-header] { "type": "basic", "title": "Examples", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{ \n \"success\":true,\n \"payload\":{ \n \"id\":\"txn_2387jmsjm234asdf02sf2\"\n }\n}", "language": "json" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{ \n \"success\":false,\n \"message\":\"Authentication failed.\"\n}", "language": "json" } ], "sidebar": true } [/block] [block:api-header] { "type": "basic", "title": "Error Codes" } [/block] [block:parameters] { "data": { "0-0": "E", "0-1": "The system is unable to process your transaction at this time", "1-1": "This transaction has already been submitted for processing", "1-0": "E", "2-1": "Valid Referring ID or approved Credit PIN Required", "2-0": "E", "3-1": "This credit has been submitted", "4-1": "The original transaction has already been reversed with transaction ID", "5-1": "The reversal for transaction has been submitted", "6-1": "The database is currently unavailable", "7-1": "Check Number Required For {TRANSACTION_TYPE} Transactions", "8-1": "State Required For POP Transactions", "9-1": "Failed to accept this transaction", "3-0": "E", "4-0": "E", "5-0": "E", "6-0": "E", "7-0": "E", "8-0": "E", "9-0": "E", "10-0": "E", "10-1": "'{MERCHANT_ID}' is an invalid Merchant ID", "11-1": "'{ROUTING_NUMBER}' is an invalid Routing Number", "12-1": "'{ACCOUNT_NUMBER}' is an invalid Account Number", "13-1": "'{AMOUNT}' is an invalid Amount", "14-1": "Credits are limited to 50,000,000 USD", "15-1": "Routing Number '{ROUTING_NUMBER}' was not found", "16-1": "This is a duplicate transaction", "17-1": "Duplicate transaction for this check. Check number: {CHECK_NUMBER}", "18-0": "E", "18-1": "Credit amount is over the maximum", "11-0": "E", "12-0": "E", "13-0": "E", "14-0": "E", "15-0": "E", "16-0": "E", "17-0": "E", "19-1": "Unable to accept {TRANSACTION_TYPE} transactions for this merchant", "20-1": "Exceeded maximum dollar amount (${AMOUNT_LIMIT}) for this merchant.", "21-1": "You have exceeded the allowed max daily num checks for this merchant", "22-1": "You have exceeded your allowed max dollar amount for this merchant of", "23-1": "You have exceeded the allowed max daily num checks overall", "24-1": "You have exceeded your allowed max dollar amount overall of", "25-1": "You have exceeded the maximum number of checks for this merchant this period", "26-1": "You have exceeded the maximum dollar amount for this merchant this period", "27-1": "You have exceeded the maximum number of checks overall this period", "28-1": "You have exceeded the maximum dollar amount overall this period", "29-1": "You have exceeded your monthly transaction volume", "30-1": "You have exceeded your monthly dollar amount cap", "31-1": "This transaction brings your monthly dollar amount over the maximum average amount allowed", "19-0": "E", "20-0": "E", "21-0": "E", "22-0": "E", "23-0": "E", "24-0": "E", "25-0": "E", "26-0": "E", "27-0": "E", "28-0": "E", "29-0": "E", "30-0": "E", "31-0": "E", "h-1": "Error Message", "h-0": "Error Type" }, "cols": 2, "rows": 32 } [/block]
The Response object indicates the success of the request and may contain relevant payload data. [block:html] { "html": "<br>" } [/block] [block:api-header] { "type": "basic", "title": "Response Object" } [/block] [block:parameters] { "data": { "h-0": "Field", "h-1": "Data Type", "0-0": "success", "1-0": "message", "2-0": "payload", "0-1": "boolean", "1-1": "string", "2-1": "object" }, "cols": 3, "rows": 3 } [/block] [block:html] { "html": "<br><br><br><br><br><br><br>", "sidebar": true } [/block] [block:api-header] { "type": "basic", "title": "Examples", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{ \n \"success\":true,\n \"payload\":{ \n \"id\":\"txn_2387jmsjm234asdf02sf2\"\n }\n}", "language": "json" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{ \n \"success\":false,\n \"message\":\"Authentication failed.\"\n}", "language": "json" } ], "sidebar": true } [/block] [block:api-header] { "type": "basic", "title": "Error Codes" } [/block] [block:parameters] { "data": { "0-0": "E", "0-1": "The system is unable to process your transaction at this time", "1-1": "This transaction has already been submitted for processing", "1-0": "E", "2-1": "Valid Referring ID or approved Credit PIN Required", "2-0": "E", "3-1": "This credit has been submitted", "4-1": "The original transaction has already been reversed with transaction ID", "5-1": "The reversal for transaction has been submitted", "6-1": "The database is currently unavailable", "7-1": "Check Number Required For {TRANSACTION_TYPE} Transactions", "8-1": "State Required For POP Transactions", "9-1": "Failed to accept this transaction", "3-0": "E", "4-0": "E", "5-0": "E", "6-0": "E", "7-0": "E", "8-0": "E", "9-0": "E", "10-0": "E", "10-1": "'{MERCHANT_ID}' is an invalid Merchant ID", "11-1": "'{ROUTING_NUMBER}' is an invalid Routing Number", "12-1": "'{ACCOUNT_NUMBER}' is an invalid Account Number", "13-1": "'{AMOUNT}' is an invalid Amount", "14-1": "Credits are limited to 50,000,000 USD", "15-1": "Routing Number '{ROUTING_NUMBER}' was not found", "16-1": "This is a duplicate transaction", "17-1": "Duplicate transaction for this check. Check number: {CHECK_NUMBER}", "18-0": "E", "18-1": "Credit amount is over the maximum", "11-0": "E", "12-0": "E", "13-0": "E", "14-0": "E", "15-0": "E", "16-0": "E", "17-0": "E", "19-1": "Unable to accept {TRANSACTION_TYPE} transactions for this merchant", "20-1": "Exceeded maximum dollar amount (${AMOUNT_LIMIT}) for this merchant.", "21-1": "You have exceeded the allowed max daily num checks for this merchant", "22-1": "You have exceeded your allowed max dollar amount for this merchant of", "23-1": "You have exceeded the allowed max daily num checks overall", "24-1": "You have exceeded your allowed max dollar amount overall of", "25-1": "You have exceeded the maximum number of checks for this merchant this period", "26-1": "You have exceeded the maximum dollar amount for this merchant this period", "27-1": "You have exceeded the maximum number of checks overall this period", "28-1": "You have exceeded the maximum dollar amount overall this period", "29-1": "You have exceeded your monthly transaction volume", "30-1": "You have exceeded your monthly dollar amount cap", "31-1": "This transaction brings your monthly dollar amount over the maximum average amount allowed", "19-0": "E", "20-0": "E", "21-0": "E", "22-0": "E", "23-0": "E", "24-0": "E", "25-0": "E", "26-0": "E", "27-0": "E", "28-0": "E", "29-0": "E", "30-0": "E", "31-0": "E", "h-1": "Error Message", "h-0": "Error Type" }, "cols": 2, "rows": 32 } [/block]