{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"7815deea-f46d-4e86-aa69-68eeda68f98f","name":"Interchecks RESTful API v1","description":"The Interchecks RESTful API enables payers to manage recipients, recipient payment accounts, and generate payments.\n\n# Latest News\n\n#### 01-07-2021 ####\n##### API V2 Documentation\nAPI V2 documentation has been published to https://docs.interchecks.io.\n\n#### 09-09-2021 ####\n##### Production URL Updates\nNew implementations will not use the interchecks.com domain for API interaction.  Please contact tech@interchecks.com to discuss the new production URL.\n\n#### 05-26-2020\n##### URL Housekeeping\nWe have updated our sandbox URL to https://test.interchecks.com.  The previous URL of https://sandbox.icapps.io will still work in the meantime, however Widget URLs will be test.interchecks.com.  Customers with a White Labeled domain will receive a custom sandbox URL.\n\n#### 10-09-2018\n##### Widget UI for `CARD` collection\nDon't want to handle card data, but want to process `CARD` transactions?  For PCI Compliance, we can handle the card data collection using a secure form.  See the **Create Account with UI URL** call detail.  The saved account information (`account_id` and `account_type`) can be posted back to the callback URL or can be retrieved via API call.\n\n##### Payment Transactions\nWe've introduced a new process for sending payments if a UI/Widget is not required and you would like to fully handle the user interface.  The `transactions` endpoint will accept direct transactions with type of `CREDIT`.  The caveat is an account must be created for each method to be passed via `account_id` in the request.  The Workflows area has been updated to note this option.\n\n\n#### 08-29-2019\n##### DEBIT updated to CARD\nIn order to enable a single CARD account to be used for both money-in and money-out, we have moved to a single account type of `CARD` - We will no longer store payment accounts of the type `DEBIT`.  If you send in a type of `DEBIT` for a `Create Account` call, it will be stored as `CARD`.\n\n# Environments\n#### Development/Sandbox: https://test.interchecks.com\n#### Production: Contact tech@interchecks.com for the production URL\n\n\n# Authentication\nEvery request must contain the Basic Authentication header using the **Account ID** and **Secret Key** values, base64 encoded as the Authorization header and prefixed with “Basic “.\n \nExample: Account ID abc and Secret Key xyz would be joined with a colon (abc:xyz) and base64 encoded.  The resulting Authorization header value would be: `Basic YWJjOnh5eg==`\n\nEvery request must also contain your **Payer ID** in the URL path.  Contact support@interchecks.com to receive your set of API Credentials to begin testing.\n\n# Response Codes\n\nResponse Code | Detail\n:---: | ---\n200 | Successful request.  The server received the request and processed it.\n400 | Bad request caused from data structure or invalid parameters.\n401 | The account used to invoke the request is not found.\n403 | The account used to invoke the request does not have the appropriate API access.\n404 | Invalid path to the API or API is being deployed.\n405 | Method not allowed error - could be caused by a POST to an invalid URL.\n409 | Duplicate request based on request_reference_id\n500 | The application encountered an error while processing the request.\n\n# Error Structure\nEach object returned in the response can indicate there is an error with the corresponding request object.  The error contain the following fields as an example:\n\n```{\n    \"error\": true,\n    \"error_message\": \"Invalid recipient data\",\n    \"error_code\": \"R02\",\n    \"errors\": [\n        \"Invalid first name\",\n        \"Invalid last name\"\n    ]\n}```\n\n\n## Error Codes\nError codes are provided in the case you would like to translate the codes into your own error messaging.\n\nError Code | Message\n--- | ---\nGE01 | An unknown error occured. Support has been notified\nP01 | Invalid Payer ID passed in the URL\nPR01 | Duplicate payment request based on Request Reference ID\nTR01 | Duplicate transaction request based on Request Reference ID\nR01 | Invalid recipient ID passed in the URL\nR02 | Invalid recipient data\nR03 | Error orccured while processing recipient data\nR04 | Recipient email already exists.  Existing ID is reflected in the response\nR05 | Recipient not found\nR06 | TIN Verification error\nR07 | Recipient email exists with a different verified TIN. Correct the TIN or remove it from the request.\nPE01 | Payment amount must be greater than zero\nPE02 | Error occurred while processing payments request\nPE03 | Request contains no valid payments, check the payment_failures response for detail\nPE04 | Error processing payment\nPE05 | Recipient not found for payment\nPE06 | Payment amount greater than allowed maximum amount\nPE07 | Payment amount requires approval\nPE08 | Payer not setup for account type, contact your account manager\nPB01 | Invalid Request ID passed in the URL\nPB02 | Invalid Request Reference ID passed in the URL\nPB03 | Payments within this request have been paid\nS01 | Invalid or missing search parameters\nPO00 | Invalid amount\nPO01 | Payout error, see error message for detail\nPO02 | Payout error, see error message for detail\nPO03 | Payout method not available\nPO04 | Payout not found\nPO05 | Payout in immutable status\nRA00 | Invalid account ID\nRA01 | Missing account details\nRA02 | Invalid Routing Number\nRA03 | Invalid account details\nRA04 | Invalid account type\nRA05 | Account type does not match method\nRA06 | Account requires verification or not eligible for TransactionType\nRA07 | Error adding card\nRA08 | Error validating card\nRA09 | Invalid expiration date\nRA10 | Account not created\nRA11 | Account creation is processing, callback process will include final status\nRA12 | Invalid or missing Address\nPA00 | Payment method is not valid for Payer\nPA01 | Invalid account type\nPA02 | Invalid routing number\nPA03 | Invalid account number\nPA04 | Invalid account email\nPA05 | Invalid address - State or Province\nPA06 | Invalid account ID\nPA07 | Invalid address - Country Code\nPA08 | Invalid Security Code/CVV\nPA09 | Invalid zip code for account\nPA10 | Account not eligible\nPA11 | Account not eligible for requested action\n\n# Workflows\nIf you have any questions on the best workflow for your use-case please email tech@interchecks.com.\n\n## Payouts\n### Payment with Widget/UI\nThe **Create Payment API** call with the optional UI URL request parameter will create/find a recipient, create a payment, and generate a URL that can be framed-in or shown in any manner to the recipient.  The recipient can select from the available payout methods and accept payment.\n\n### Payment with Payout\nThe **Create Payment API** call supports 3 operations in a nested structure: Create Recipient, Payment, and Payout Transaction or request a URL for the Recipient to accept payment.  We'll maintain this legacy process for those who want a one-call-does-it-all integration.  Payout Methods for `INSTANT_DEPOSIT` and any type of `PREPAID` require an `account_id` to be used.  Review the **Create with INSTANT DEPOSIT payout** detail.\n\nStandard process for Payments with Payout\n+ Create Account (if applicable - only required for `INSTANT_DEPOSIT` payout methods)\n+ Create Payment w/ Payout Transaction structure\n\nProcedural process\n+ Create Recipient\n+ Create Account (if applicable - only required for `INSTANT_DEPOSIT` payout methods)\n+ Create Payment w/ Payout Transaction structure\n** The Direct Payments process below is better suited for procedural processing.\n\n### Payment Transaction\nThe **Transactions** API call now handles direct transactions (CREDIT).  This process does not create a payment on the Interchecks platform, but performs a direct transaction for the recipient to the `account_id` specified.  The request/response structure is greatly simplified from the **Payments** process.  Transactions appear under the **Payments Completed** section of the Payer Portal.\n\nThere are 3 required steps.\n+ Create Recipient\n+ Create Account - For PCI Compliance, we can handle the card data collection using a secure form.  See the **Create Account with UI URL** call detail.\n+ Create Transaction with `CREDIT` transaction type.\n\n\n# Test Debit/Credit Cards\nAny future expiration date will work.\n\nCard Number\t| Type | Pull (Money-In) | Push (Money-Out)\n--- | --- | --- | ---\n9400100999999993 | DEBIT | N | N\n9400101999999991 | DEBIT | N | Y\n9400102999999999 | DEBIT | N | Y \n9400103999999997 | DEBIT | N | Y \n9400110999999992 | DEBIT | Y | N\n9400111999999990 | DEBIT | Y | Y\n9400112999999998 | DEBIT | Y | Y \n9400113999999996 | DEBIT | Y | Y \n9400120999999991 | DEBIT | Y | N\n9400121999999999 | DEBIT | Y | Y \n9400122999999997 | DEBIT | Y | Y \n9400123999999995 | DEBIT | Y | Y \n9400200999999991 | CREDIT | N | N\n9400201999999999 | CREDIT | N | Y\n9400202999999997 | CREDIT | N | Y\n9400203999999995 | CREDIT | N | Y\n9400210999999990 | CREDIT | Y | N\n9400211999999998 | CREDIT | Y | Y\n9400212999999996 | CREDIT | Y | Y\n9400213999999994 | CREDIT | Y | Y\n9400220999999999 | CREDIT | Y | N\n9400221999999997 | CREDIT | Y | Y\n9400222999999995 | CREDIT | Y | Y\n9400223999999993 | CREDIT | Y | Y","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"598227","team":174438,"collectionId":"7815deea-f46d-4e86-aa69-68eeda68f98f","publishedId":"UVJfjvS3","public":true,"publicUrl":"https://docs-v1.interchecks.com","privateUrl":"https://go.postman.co/documentation/598227-7815deea-f46d-4e86-aa69-68eeda68f98f","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2021-12-02T19:09:13.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/00b6d37153faa9dc9510d7141c56b0093ed40c09020aff20dba04a09e48c15fd","favicon":"https://interchecks.com/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://docs-v1.interchecks.com/view/metadata/UVJfjvS3"}