{"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.

Latest News

01-07-2021

API V2 Documentation

API V2 documentation has been published to https://docs.interchecks.io.

09-09-2021

Production URL Updates

New implementations will not use the interchecks.com domain for API interaction. Please contact tech@interchecks.com to discuss the new production URL.

05-26-2020

URL Housekeeping

We 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.

10-09-2018

Widget UI for `CARD` collection

Don'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.

Payment Transactions

We'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.

08-29-2019

DEBIT updated to CARD

In 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.

Environments

Development/Sandbox: https://test.interchecks.com

Production: Contact tech@interchecks.com for the production URL

Authentication

Every 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 “.

Example: 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==

Every 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.

Response Codes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Response Code	Detail
200	Successful request. The server received the request and processed it.
400	Bad request caused from data structure or invalid parameters.
401	The account used to invoke the request is not found.
403	The account used to invoke the request does not have the appropriate API access.
404	Invalid path to the API or API is being deployed.
405	Method not allowed error - could be caused by a POST to an invalid URL.
409	Duplicate request based on request_reference_id
500	The application encountered an error while processing the request.

Error Structure

Each 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:

{ \"error\": true, \"error_message\": \"Invalid recipient data\", \"error_code\": \"R02\", \"errors\": [ \"Invalid first name\", \"Invalid last name\" ] }

Error Codes

Error codes are provided in the case you would like to translate the codes into your own error messaging.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Error Code	Message
GE01	An unknown error occured. Support has been notified
P01	Invalid Payer ID passed in the URL
PR01	Duplicate payment request based on Request Reference ID
TR01	Duplicate transaction request based on Request Reference ID
R01	Invalid recipient ID passed in the URL
R02	Invalid recipient data
R03	Error orccured while processing recipient data
R04	Recipient email already exists. Existing ID is reflected in the response
R05	Recipient not found
R06	TIN Verification error
R07	Recipient email exists with a different verified TIN. Correct the TIN or remove it from the request.
PE01	Payment amount must be greater than zero
PE02	Error occurred while processing payments request
PE03	Request contains no valid payments, check the payment_failures response for detail
PE04	Error processing payment
PE05	Recipient not found for payment
PE06	Payment amount greater than allowed maximum amount
PE07	Payment amount requires approval
PE08	Payer not setup for account type, contact your account manager
PB01	Invalid Request ID passed in the URL
PB02	Invalid Request Reference ID passed in the URL
PB03	Payments within this request have been paid
S01	Invalid or missing search parameters
PO00	Invalid amount
PO01	Payout error, see error message for detail
PO02	Payout error, see error message for detail
PO03	Payout method not available
PO04	Payout not found
PO05	Payout in immutable status
RA00	Invalid account ID
RA01	Missing account details
RA02	Invalid Routing Number
RA03	Invalid account details
RA04	Invalid account type
RA05	Account type does not match method
RA06	Account requires verification or not eligible for TransactionType
RA07	Error adding card
RA08	Error validating card
RA09	Invalid expiration date
RA10	Account not created
RA11	Account creation is processing, callback process will include final status
RA12	Invalid or missing Address
PA00	Payment method is not valid for Payer
PA01	Invalid account type
PA02	Invalid routing number
PA03	Invalid account number
PA04	Invalid account email
PA05	Invalid address - State or Province
PA06	Invalid account ID
PA07	Invalid address - Country Code
PA08	Invalid Security Code/CVV
PA09	Invalid zip code for account
PA10	Account not eligible
PA11	Account not eligible for requested action

Workflows

If you have any questions on the best workflow for your use-case please email tech@interchecks.com.

Payouts

Payment with Widget/UI

The 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.

Payment with Payout

The 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.

Standard process for Payments with Payout

Create Account (if applicable - only required for INSTANT_DEPOSIT payout methods)
Create Payment w/ Payout Transaction structure

Procedural process

Create Recipient
Create Account (if applicable - only required for INSTANT_DEPOSIT payout methods)
Create Payment w/ Payout Transaction structure\n** The Direct Payments process below is better suited for procedural processing.

Payment Transaction

The 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.

There are 3 required steps.

Create Recipient
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.
Create Transaction with CREDIT transaction type.

Test Debit/Credit Cards

Any future expiration date will work.

Card Number	Type	Pull (Money-In)	Push (Money-Out)
9400100999999993	DEBIT	N	N
9400101999999991	DEBIT	N	Y
9400102999999999	DEBIT	N	Y
9400103999999997	DEBIT	N	Y
9400110999999992	DEBIT	Y	N
9400111999999990	DEBIT	Y	Y
9400112999999998	DEBIT	Y	Y
9400113999999996	DEBIT	Y	Y
9400120999999991	DEBIT	Y	N
9400121999999999	DEBIT	Y	Y
9400122999999997	DEBIT	Y	Y
9400123999999995	DEBIT	Y	Y
9400200999999991	CREDIT	N	N
9400201999999999	CREDIT	N	Y
9400202999999997	CREDIT	N	Y
9400203999999995	CREDIT	N	Y
9400210999999990	CREDIT	Y	N
9400211999999998	CREDIT	Y	Y
9400212999999996	CREDIT	Y	Y
9400213999999994	CREDIT	Y	Y
9400220999999999	CREDIT	Y	N
9400221999999997	CREDIT	Y	Y
9400222999999995	CREDIT	Y	Y
9400223999999993	CREDIT	Y	Y

","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Latest News","slug":"latest-news"},{"content":"Environments","slug":"environments"},{"content":"Authentication","slug":"authentication"},{"content":"Response Codes","slug":"response-codes"},{"content":"Error Structure","slug":"error-structure"},{"content":"Workflows","slug":"workflows"},{"content":"Test Debit/Credit Cards","slug":"test-debitcredit-cards"}],"owner":"598227","collectionId":"7815deea-f46d-4e86-aa69-68eeda68f98f","publishedId":"UVJfjvS3","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2021-12-02T19:09:13.000Z"},"item":[{"name":"Recipients","item":[{"name":"Create","id":"142c31af-f87f-45d7-9ca1-6fee7328aaee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"recipient_email\": \"art1@interchecks.com\",\n\t\"recipient_first_name\": \"Art\",\n\t\"recipient_last_name\": \"Vandelay\"\n}\n\n"},"url":"https://test.interchecks.com/api/v1.0/recipients/{{payer_id}}","description":"

Create recipient with first name, last name, and email.

Create recipient with first name, last name, email, TIN, and address.

If your payer profile is configured for W9 collection and the TIN is provided, we will perform a KYC check on the recipient. Two additional fields will be returned with the recipient recipient_w9_required and recipient_w9_verified to provide you insight into your recipient's account.
\n
recipient_reference_id is an optional parameter to add your identifier to the recipient's account
\n
recipient_1099_delivery is an optional parameter to define how we will deliver the 1099 if applicable. Optional values are EMAIL, MAIL. The default value is EMAIL.
\n

Update recipient with TIN and address.

If you are collecting TIN after an amount threshold and the recipient's account is already created, issue a PUT request to add TIN and perform a KYC check on the recipient.
recipient_1099_delivery is an optional parameter to define how we will deliver the 1099 if applicable. Optional values are EMAIL, MAIL. The default value is EMAIL.

Update recipient first name, last name, and email using the recipient ID.

Get recipient using the recipient ID.

Search for a recipient using an email address. A recipient not found will return a 404 response code and an error structure.

API calls to manage recipients

recipient_reference_id is an optional parameter to add your identifier to the recipient's account
UPDATE with a new email address will add a new primary email address for the recipient
UPDATE with new first and last name will only update if recipient has not setup their profile and a KYC has not been completed
If your payer profile is configured for W9 collection, two additional fields will be returned with the recipient recipient_w9_required and recipient_w9_verified to provide you insight into your recipient's account.

\n","event":[{"listen":"prerequest","script":{"id":"f70e3600-04dc-48d0-a250-ca1dd89fe0b3","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"779b98d7-81d0-4253-a0b8-723c988ec843","type":"text/javascript","exec":[""]}}],"_postman_id":"c4ff980d-138e-47d9-8e78-9a5c10e0c99a","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}]},"isInherited":true,"source":{"_postman_id":"7815deea-f46d-4e86-aa69-68eeda68f98f","id":"7815deea-f46d-4e86-aa69-68eeda68f98f","name":"Interchecks RESTful API v1","type":"collection"}}},{"name":"Accounts","item":[{"name":"Create Account","id":"5d1496da-ce06-4139-bf99-5fcca12f4905","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"type\": \"CARD\",\n\t\"account_number\" : 9400110999999992,\n\t\"exp_date\": \"12/22\",\n\t\"zip_code\" : 99999,\n\t\"security_code\" : 888\n}"},"url":"https://test.interchecks.com/api/v1.0/accounts/{{payer_id}}/RELT4PQbqqTUSVOYwP4KXcvQ","description":"

Create a payment account for a recipient. The required URL structure is /accounts/payer_id/recipient_id in order to correctly assign an account to a Recipient.

Required/Optional payload fields for each Account Type below.

ACH Account
\n
type - ACH - required.
\n
account_type - required. Values are CHECKING,SAVINGS,BUSINESS
\n
account_number - required.
\n
routing_number - required.
\n
CARD Account for Instant Deposit. Evaluate the push_available and/or pull_available to determine if the CARD account meets the criteria for the required action. Optionally, pass in the pull_required/push_required and we validate the the criteria and supply an error response.
\n
type - CARD - required.
\n
account_number - required - 16 Digit Debit Card number.
\n
exp_date - required - format of MM/YY.
\n
push_required - optional - we will validate the CARD is available for money-out/push transactions.
\n
pull_required - optional - we will validate the CARD is available for money-in/pull transactions.
\n
CHECK Account
\n
type - CHECK - required.
\n
address - Object
\n
address - required
\n
city - required
\n
state - required. 2 character state code.
\n
zip - required. 5 or 9 digit zip code
\n
country - optional. US is default
\n
ECHECK Account
\n
type - EMAIL - required.
\n
email - optional. If no email is provided, the payment will be delivered to the recipient's primary email
\n
PAYPAL Account
\n
type - PAYPAL - required.
\n
email - required. The recipient's paypal email address.
\n
VIRTUALCARD_MASTERCARD, PHYSICALCARD_MASTERCARD, VIRTUALCARD_VISA, PHYSICALCARD_VISA Account
\n
type - VIRTUALCARD_MASTERCARD or PHYSICALCARD_MASTERCARD or VIRTUALCARD_VISA or PHYSICALCARD_VISA - required
\n
address - Object
\n
address_1 - required
\n
address_2 - optional
\n
city - required
\n
state - required. 2 character state code.
\n
zip - required. 5 or 9 digit zip code
\n
country - optional. US is default
\n
dob - required. YYYY-MM-DD format
\n
phone - required. 10 digits
\n
ssn - required. 9 digits
\n

In addition to the account type parameters, two callback parameters are available: callback_url and callback_params.

Callback parameters to receive the relevant data after the account is saved.
callback_url - fully qualified URL of your postback handler
callback_params - string array of requested params. Available options are [recipient_id, account_id]

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}]},"isInherited":true,"source":{"_postman_id":"7815deea-f46d-4e86-aa69-68eeda68f98f","id":"7815deea-f46d-4e86-aa69-68eeda68f98f","name":"Interchecks RESTful API v1","type":"collection"}},"urlObject":{"path":["api","v1.0","accounts","{{payer_id}}","RELT4PQbqqTUSVOYwP4KXcvQ"],"host":["https://test.interchecks.com"],"query":[],"variable":[]}},"response":[{"id":"5bae7946-c388-475b-aaa4-dc8236940ae3","name":"Create CARD Account - Valid","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"type\": \"CARD\",\n\t\"account_number\" : 9400110999999992,\n\t\"exp_date\": \"12/22\",\n\t\"zip_code\" : 99996,\n\t\"security_code\" : 888\n}"},"url":"https://test.interchecks.com/api/v1.0/accounts/{{payer_id}}/RELT4PQbqqTUSVOYwP4KXcvQ"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 09 Aug 2019 14:07:01 GMT"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Set-Cookie","value":"SESSION=MTk4MDc0ZjItZWNhMy00Njk4LTk0OTktYjFhZDE0NzU2OWZl; Path=/; Secure; HttpOnly; SameSite=Lax"},{"key":"Via","value":"1.1 vegur"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"503a4b2f6f0dc86b-MIA"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"RPA-q-Z0D4gARrugekd0CHfPhQ\",\n \"type\": \"CARD\",\n \"account_type\": \"DEBIT\",\n \"account_number\": \"940011******9992\",\n \"created_date\": \"2019-08-09T14:06:59+0000\",\n \"description\": \"Visa Debit\",\n \"push_available\": false,\n \"pull_available\": true,\n \"avs_return_code\": \"Z\",\n \"avs_security_code\": \"M\"\n}"},{"id":"8bf8e453-8d50-4261-acad-f9d58b96b7d4","name":"Create PREPAID Account","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"\"type\": \"PHYSICALCARD_VISA\",\n \"first_name\" : \"ART\",\n \"last_name\" : \"VANDELAY\",\n \"dob\" : \"2000-01-01\",\n \"phone\" : \"9545555555\",\n \"ssn\" : \"234567890\",\n\t\"address\" : {\n\t\t\"address_1\" : \"901 NW 35th Street\",\n\t\t\"city\" : \"Boca Raton\",\n\t\t\"state\" : \"FL\",\n\t\t\"zip\" : \"33431\"\n\t\t\"country\" : \"US\"\n\t}"},"url":"https://test.interchecks.com/api/v1.0/accounts/{{payer_id}}/{{recipient_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 09 Aug 2019 14:07:01 GMT"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Set-Cookie","value":"SESSION=MTk4MDc0ZjItZWNhMy00Njk4LTk0OTktYjFhZDE0NzU2OWZl; Path=/; Secure; HttpOnly; SameSite=Lax"},{"key":"Via","value":"1.1 vegur"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"503a4b2f6f0dc86b-MIA"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"RPA-123456ABCDEF\",\n \"type\": \"PHYSICALCARD_VISA\",\n \"email\": \"art@interchecks.com\",\n \"account_type\": \"Visa® Prepaid Card\",\n \"routing_number\": \"073972181\",\n \"account_number\": \"123456789\",\n \"created_date\": \"2021-08-05T15:24:23+0000\",\n \"account_status\": \"PENDING_ACTIVATION\",\n \"account_balance\": 0.0,\n \"card_number\": \"4***********1418\"\n}"},{"id":"bac55056-93c1-4977-88f7-a4a30529d193","name":"Create CARD Account - Invalid Zip Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"type\": \"CARD\",\n\t\"account_number\" : 9400110999999992,\n\t\"exp_date\": \"12/22\",\n\t\"zip_code\" : 99992,\n\t\"security_code\" : 888\n}"},"url":"https://test.interchecks.com/api/v1.0/accounts/{{payer_id}}/RELT4PQbqqTUSVOYwP4KXcvQ"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 09 Aug 2019 14:09:49 GMT"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Set-Cookie","value":"SESSION=NDhkNTcyYWUtMTIxMi00OTFlLTlmNzUtYTZhNzk5ODlkYTNl; Path=/; Secure; HttpOnly; SameSite=Lax"},{"key":"Via","value":"1.1 vegur"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"503a4f51ff7fc86b-MIA"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": true,\n \"error_message\": \"Invalid zip code for account\",\n \"error_code\": \"PA09\"\n}"},{"id":"8056bafd-e79c-485c-beea-d1ccd98b5a8e","name":"Create CARD Account - Invalid CVV","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"type\": \"CARD\",\n\t\"account_number\" : 9400110999999992,\n\t\"exp_date\": \"12/22\",\n\t\"zip_code\" : 99999,\n\t\"security_code\" : 999\n}"},"url":"https://test.interchecks.com/api/v1.0/accounts/{{payer_id}}/RELT4PQbqqTUSVOYwP4KXcvQ"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 09 Aug 2019 14:10:24 GMT"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Set-Cookie","value":"SESSION=YTFjZjA3ZWQtMzdjZC00NjU4LWFjZDQtZTJiMzNjYWJhMjA5; Path=/; Secure; HttpOnly; SameSite=Lax"},{"key":"Via","value":"1.1 vegur"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"503a502f5acec86b-MIA"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": true,\n \"error_message\": \"Invalid Security Code/CVV\",\n \"error_code\": \"PA08\"\n}"}],"_postman_id":"5d1496da-ce06-4139-bf99-5fcca12f4905"},{"name":"Create Account with UI URL","id":"f6e4a244-afab-486a-9550-58bcffd027d5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"type\": \"CARD\",\n\t\"ui_url\" : true,\n\t\"push_required\" : true,\n\t\"pull_required\" : true,\n\t\"callback_url\" : \"https://my-domain-url/webhooks/callback\",\n\t\"callback_params\": [\"recipient_id\", \"account_id\"]\n}"},"url":"https://test.interchecks.com/api/v1.0/accounts/{{payer_id}}/RELT4PQbqqTUSVOYwP4KXcvQ","description":"

Generate a secure URL for the recipient to add an Account. This is relevant for clients not collecting card data who want to add a CARD account. We recommend adding your callback_url and the shown callback_params to receive the ID for the account added.

To improve the user-experience, we can customize the account validation process depending on the CARD account requirements.

If you require the CARD to only be used to send CREDIT transactions, include push_required : true in the request. We will validate the card can accept payments.
\n
If no push_required, pull_required are included in the request, pull_required will default to true.
\n

Retrieve account by ID.

Delete account by ID.

Retrieve array list of Accounts by TYPE: CARD, DEBIT, ACH, PAYPAL, ECHECK, CHECK

Account API calls to facilitate Payouts and Transactions and manage recipient accounts

The Account ID can be used to complete a Payment with Payout Transaction or issue DEBIT/CREDIT Payment Transactions.

CARD and PREPAID account types are required to be created prior to initiating a Payout or Transaction.

\n","event":[{"listen":"prerequest","script":{"id":"26815059-4a94-45b6-b327-78d1ca6f0251","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"0cbd625e-c523-43c1-916f-bcd9369d63f0","type":"text/javascript","exec":[""]}}],"_postman_id":"51de373e-54f4-422e-876a-ac5375d9e422","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}]},"isInherited":true,"source":{"_postman_id":"7815deea-f46d-4e86-aa69-68eeda68f98f","id":"7815deea-f46d-4e86-aa69-68eeda68f98f","name":"Interchecks RESTful API v1","type":"collection"}}},{"name":"Payments","item":[{"name":"Create","id":"8b073882-4ec8-4b2a-bd34-53734b605c90","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"request_reference_id\" : \"txn-900001\",\n\t\"recipient\":\n\t{\n\t\t\"recipient_first_name\" : \"Art\",\n\t\t\"recipient_last_name\" : \"Vandelay\",\n\t\t\"recipient_email\": \"art@interchecks.com\",\n\t\t\"payments\":[\n\t\t\t{\n\t\t\t\"payment_amount\": 25\n\t\t\t}\n\t\t]\n\t},\n\t\"callback_url\" : \"https://myserver.com/callback/url\",\n\t\"callback_params\" : [\"request_id\",\"payment_status\"]\n\n}\n"},"url":"https://test.interchecks.com/api/v1.0/payments/{{payer_id}}","description":"

Create a Payment for Portal Acceptance

Post a Payment to the Interchecks Portal for the Recipient to enroll and accept. The Recipient will have the option of selecting from 1 or more payout methods configured for your payer account.

Payment UI URL

Using the parameter \"payments_ui_url\": true in the recipient object will generate a secure URL for the recipient to accept their payment. The URL can be used in an iFrame or the user can be redirected. Appending the parameter ?redirectUrl=http://www.yoursite.com to the returned URL will force a redirect after the process is complete.

Paying with an Account ID

After creating an account (via Payout Request), Payouts can be processed using the account_id. This is most useful for Debit accounts but can be used for any Payout in which we create an account for: PayPal, ACH, and Debit (Instant deposit)

Required/Optional fields for Payout method

method - required.
account_id - required.

Required/Optional fields for Payout methods

ACH_STANDARD, ACH_SAME_DAY, CHECK_DEPOSIT
account_type - required. Values are CHECKING,SAVINGS,BUSINESS
account_number - required.
routing_number - required.

CHECK
address - required
city - required.
state - required. 2 character state code.
zip - required. 5 or 9 digit zip code.

Required/Optional fields for Payout methods

ECHECK
email - optional. If no email is provided, the payment will be delivered to the recipient's primary email

Paying with a Card Number - Important

The first payout request for Instant Deposit requires the card number (account number) and expiration date. We validate the Debit Card is eligible for instant deposits prior to processing the transaction. If successful, the payout_transaction response object will contain an account_id value which is to be used for all subsequent Instant Deposit requests.

Failure to use the account_id in subsequent payout requests could result in failed transactions due to duplicate debit card accounts being created on the platform.

If the recipient's card number has changed, send the new card number and expiration date to receive a new account_id.

Multiple active Debit accounts per recipient are allowed

Please contact tech@interchecks.com to receive test card numbers related to your Payer account

Required/Optional fields for Payout method

INSTANT_DEPOSIT
account_number - required - 16 Digit Debit Card number.
exp_date - required - format of MM/YY.

PAYPAL
email - required. The recipient's paypal email address.

A recipient_id can be supplied in favor of recipient email, first name, and last name.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}]},"isInherited":true,"source":{"_postman_id":"7815deea-f46d-4e86-aa69-68eeda68f98f","id":"7815deea-f46d-4e86-aa69-68eeda68f98f","name":"Interchecks RESTful API v1","type":"collection"}},"urlObject":{"path":["api","v1.0","payments","{{payer_id}}"],"host":["https://test.interchecks.com"],"query":[],"variable":[]}},"response":[{"id":"7895d200-9748-4433-a1f6-12dd9fef8af6","name":"Create with Recipient ID","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"recipient\":\n\t{\n\t\t\"recipient_id\" : \"REtrOlA_A8R6q6Iegs0xFsXg\",\n\t\t\"payments\":[\n\t\t\t{\n\t\t\t\"payment_amount\": 32.00\n\t\t\t}\n\t\t],\n\t\t\"payout\" : {\n\t\t\t\"method\" : \"ECHECK\",\n\t\t\t\"email\" : \"art.vandelay@interchecks.com\"\n\t\t}\n\t}\n}\n"},"url":"https://test.interchecks.com/api/v1.0/payments/{{payer_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Date","value":"Fri, 19 Oct 2018 14:25:45 GMT"},{"key":"Expires","value":"0"},{"key":"Pragma","value":"no-cache"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Vcap-Request-Id","value":"4d57124f-5a4e-48ec-64ef-d5b514bd4b40"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Content-Length","value":"813"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"request_id\": \"AP85667-20181019-142544\",\n \"request_status\": \"FUNDED\",\n \"payments_processed\": 1,\n \"payments_created\": 1,\n \"payments_failed\": 0,\n \"recipient\": {\n \"recipient_id\": \"REtrOlA_A8R6q6Iegs0xFsXg\",\n \"recipient_email\": \"art@interchecks.com\",\n \"recipient_first_name\": \"ART\",\n \"recipient_last_name\": \"VANDELAY\",\n \"payments\": [\n {\n \"payment_id\": \"PMbM4UEWE_TuegE9qH4Yq3JA\",\n \"payment_amount\": 32,\n \"payment_reference_id\": \"AP85667-A-20181019-142544798\",\n \"payment_currency\": \"USD\",\n \"payment_status\": \"PAID\",\n \"payment_created_date\": \"2018-10-19T14:25:44+0000\"\n }\n ],\n \"payout_transaction\": {\n \"payout_id\": \"POrNg-6hWBTt2uZCT_MVauJw\",\n \"payout_amount\": 32,\n \"payout_currency\": \"USD\",\n \"payout_status\": \"Paid\",\n \"payout_date\": \"2018-10-19T14:25:45+0000\",\n \"payout_transaction_id\": \"IC-22039-198-35330\",\n \"payout_method\": \"eCheck\",\n \"payout_destination\": \"art.vandelay@interchecks.com\"\n }\n }\n}"}],"_postman_id":"4b842d41-bd9b-4c3b-b8d0-ee31bb47ca8f"},{"name":"Request Status by ID","id":"230e42b8-4bb2-4439-9108-fe9c2a059742","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://test.interchecks.com/api/v1.0/payments/{{payer_id}}/status/AP85667-20181019-142501","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}]},"isInherited":true,"source":{"_postman_id":"7815deea-f46d-4e86-aa69-68eeda68f98f","id":"7815deea-f46d-4e86-aa69-68eeda68f98f","name":"Interchecks RESTful API v1","type":"collection"}},"urlObject":{"path":["api","v1.0","payments","{{payer_id}}","status","AP85667-20181019-142501"],"host":["https://test.interchecks.com"],"query":[],"variable":[]}},"response":[{"id":"4882023d-5cb0-4a7b-b99b-faf45e46def3","name":"Request Status by ID","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://test.interchecks.com/api/v1.0/payments/{{payer_id}}/status/AP85667-20181019-142501"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Date","value":"Fri, 19 Oct 2018 15:05:55 GMT"},{"key":"Expires","value":"0"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"JSESSIONID=6D609B9B382BF9F52F5C9830CEA3A25E; Path=/; Secure; HttpOnly"},{"key":"Set-Cookie","value":"__VCAP_ID__=0cf9ab5f-baae-4df5-765e-72dd; Path=/; HttpOnly; Secure"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Vcap-Request-Id","value":"a1952021-f96a-4745-7577-5654c9c32dcc"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Content-Length","value":"835"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"payments\": [\n {\n \"recipient_id\": \"REtrOlA_A8R6q6Iegs0xFsXg\",\n \"recipient_email\": \"art@interchecks.com\",\n \"recipient_first_name\": \"ART\",\n \"recipient_last_name\": \"VANDELAY\",\n \"recipient_w9_verified\": false,\n \"recipient_w9_required\": false,\n \"payment_id\": \"PM4KN82SxvTJKBr6mBHkT8dg\",\n \"payment_amount\": 25,\n \"payment_reference_id\": \"AP85667-A-20181019-142501985\",\n \"payment_currency\": \"USD\",\n \"payment_status\": \"PAID\",\n \"payment_created_date\": \"2018-10-19T14:25:01+0000\",\n \"payment_transaction_id\": \"IC-22039-198-35329\",\n \"payout_transaction_id\": \"IC-22039-198-35329\",\n \"payout_transaction\": {\n \"payout_id\": \"POhc3PfZdbTm2sLpnjUCweSg\",\n \"payout_amount\": 25,\n \"payout_currency\": \"USD\",\n \"payout_status\": \"PAID\",\n \"payout_date\": \"2018-10-19T14:25:06+0000\",\n \"payout_transaction_id\": \"IC-22039-198-35329\",\n \"payout_method\": \"Direct Deposit\"\n }\n }\n ],\n \"request_id\": \"AP85667-20181019-142501\",\n \"payments_total\": 1\n}"}],"_postman_id":"230e42b8-4bb2-4439-9108-fe9c2a059742"},{"name":"Approve by ID","id":"fb79fd0c-9ee0-4633-a9fb-4d45b870b36a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://test.interchecks.com/api/v1.0/payments/{{payer_id}}/approve/AP85667-20181019-142501","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}]},"isInherited":true,"source":{"_postman_id":"7815deea-f46d-4e86-aa69-68eeda68f98f","id":"7815deea-f46d-4e86-aa69-68eeda68f98f","name":"Interchecks RESTful API v1","type":"collection"}},"urlObject":{"path":["api","v1.0","payments","{{payer_id}}","approve","AP85667-20181019-142501"],"host":["https://test.interchecks.com"],"query":[],"variable":[]}},"response":[{"id":"73708249-3972-4ed3-b0fb-abf03565bc27","name":"Approve by ID","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://test.interchecks.com/api/v1.0/payments/{{payer_id}}/status/AP85667-20181019-142501"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Date","value":"Fri, 19 Oct 2018 15:05:55 GMT"},{"key":"Expires","value":"0"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"JSESSIONID=6D609B9B382BF9F52F5C9830CEA3A25E; Path=/; Secure; HttpOnly"},{"key":"Set-Cookie","value":"__VCAP_ID__=0cf9ab5f-baae-4df5-765e-72dd; Path=/; HttpOnly; Secure"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Vcap-Request-Id","value":"a1952021-f96a-4745-7577-5654c9c32dcc"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Content-Length","value":"835"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"payments\": [\n {\n \"recipient_id\": \"REtrOlA_A8R6q6Iegs0xFsXg\",\n \"recipient_email\": \"art@interchecks.com\",\n \"recipient_first_name\": \"ART\",\n \"recipient_last_name\": \"VANDELAY\",\n \"payment_id\": \"PM4KN82SxvTJKBr6mBHkT8dg\",\n \"payment_amount\": 25,\n \"payment_reference_id\": \"AP85667-A-20181019-142501985\",\n \"payment_currency\": \"USD\",\n \"payment_status\": \"PAID\",\n \"payment_created_date\": \"2018-10-19T14:25:01+0000\",\n \"payment_transaction_id\": \"IC-22039-198-35329\",\n \"payout_transaction_id\": \"IC-22039-198-35329\",\n \"payout_transaction\": {\n \"payout_id\": \"POhc3PfZdbTm2sLpnjUCweSg\",\n \"payout_amount\": 25,\n \"payout_currency\": \"USD\",\n \"payout_status\": \"PAID\",\n \"payout_date\": \"2018-10-19T14:25:06+0000\",\n \"payout_transaction_id\": \"IC-22039-198-35329\",\n \"payout_method\": \"Direct Deposit\"\n }\n }\n ],\n \"request_id\": \"AP85667-20181019-142501\",\n \"payments_total\": 1\n}"}],"_postman_id":"fb79fd0c-9ee0-4633-a9fb-4d45b870b36a"},{"name":"Cancel by ID","id":"e5b0f547-51f7-451f-bced-0702674f0f6a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://test.interchecks.com/api/v1.0/payments/{{payer_id}}/cancel/AP85667-20181019-142501","description":"

A Payment request can be cancelled if the payment has not been paid to the recipient. For example, if the request processed successfully, but the payout fails or in an APPROVAL_REQUIRED status. You can cancel all payments of the original request.

If payment(s) were paid, the current status of the payments and corresponding payouts are returned.

Payment Bundling

The payments structure is an array of 1-to-n payment objects. The payments will be bundled into a single payout when processed.

Payment Request Information

request_reference_id is an optional parameter that can be included in the root object of the request. It serves as an external reference ID for a payments batch (1 or more payments). Uniqueness for this ID will be enforced for your account for all valid requests. If an existing ID is sent new payments will not be created and a 409 Conflict will be returned. If payments_ui_url is set to true, a new Widget URL will be generated and returned in the response.

Callback Option

Every create payment request can include callback_url and callback_params in the root object of the request
callback_params is a string array with the optional values:
request_id, request_reference_id, payment_reference_id, and payment_status
The callback URL will be invoked after the payment process is complete or the status of a payment changes.

Payout Request

Supplying a payout object within the recipient object will automatically disburse funds to the recipient's account. The method provided must be a payment method your payer profile supports.

Available payment methods: ECHECK, ACH_STANDARD, ACH_SAME_DAY, CHECK, PAYPAL,INSTANT_DEPOSIT,VENMO_ACH,PHYSICAL_CARD_MASTERCARD,VIRTUAL_CARD_MASTERCARD,PHYSICAL_CARD_VISA,VIRTUAL_CARD_VISA
For more information on available payment methods and disbursement SLAs contact support@interchecks.com
A Payout Response will contain provider_transaction_id - if the payment method is CHECK or ECHECK, this value will be the check number. Other payment methods will contain a transaction ID that may or may not be reflected on your bank statement.

Required/Optional fields for Payout methods

ECHECK - the payment will be delivered to the recipient's primary email
\n
ACH_STANDARD, ACH_SAME_DAY, VENMO_ACH
\n
account_type - required. Values are CHECKING,SAVINGS,BUSINESS
\n
account_number - required.
\n
routing_number - required.
\n
PAYPAL
\n
email - required. The recipient's paypal email address.
\n
CHECK
\n
address - required
\n
city - required.
\n
state - required. 2 character state code.
\n
zip - required. 5 or 9 digit zip code.
\n
INSTANT_DEPOSIT
\n
account_id - required.
\n
PHYSICAL_CARD_MASTERCARD,VIRTUAL_CARD_MASTERCARD,PHYSICAL_CARD_VISA,VIRTUAL_CARD_VISA
\n
account_id - required.
\n

The requests below shows examples for referenced parameters above

\n","event":[{"listen":"prerequest","script":{"id":"82e995e5-6bc3-480b-975c-3af511e5cd86","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"8a0720c6-0936-4acb-b795-c637958d528e","type":"text/javascript","exec":[""]}}],"_postman_id":"acecef65-7855-42bb-8e46-2af71200f480","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}]},"isInherited":true,"source":{"_postman_id":"7815deea-f46d-4e86-aa69-68eeda68f98f","id":"7815deea-f46d-4e86-aa69-68eeda68f98f","name":"Interchecks RESTful API v1","type":"collection"}}},{"name":"Transactions","item":[{"name":"Create CREDIT Transaction","id":"be2c68ab-d0a9-4d0c-a039-cc12c5199bbd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"request_reference_id\": \"txn-test-9-26\",\n\t\"account_id\" : \"RPA-9LXznEKXTpqx3hAc-6RTiw\",\n\t\"amount\": 25.00,\n\t\"type\": \"CREDIT\",\n\t\"method\" : \"INSTANT_DEPOSIT\"\n}\n"},"url":"https://test.interchecks.com/api/v1.0/transactions/{{payer_id}}/RELT4PQbqqTUSVOYwP4KXcvQ","description":"

Issue a Transaction request using the Recipient's Payment Account ID (account_id). The TYPE of DEBIT or CREDIT indicates the direction of funds movement.

Required/Optional Params

account_id - Required.
amount - Required.
type - DEBIT or CREDIT - Required.
method - ACH_STANDARD,ECHECK,CHECK,INSTANT_DEPOSIT,VIRTUAL_CARD, etc - Required.
request_reference_id - Optional. Serves as an external reference ID if applicable for your tracking.
memo - Optional. Additional detail for the transaction to be displayed to the recipient.

Issue a Payment Transaction request using the Recipient's Payment Account ID (account_id). The TYPE of DEBIT or CREDIT indicates the direction of funds movement. A DEBIT Currently, Transaction is only supported with a valid CARD account that supports pulling funds from the Recipient's account.

Card Processing Providers often require the display of certain information pre and post transaction

PRE Transaction
Description of services
Refund / cancellation policy available and agreed to by cardholder prior to transaction (click-through terms and conditions are fine)
Prices and fees for services and total amount all shown separately
Merchant name and contact information shown. Contact information can be shown on “Contact” link if displayed obvious to cardholder.
POST Transaction
Date and Time of purchase
Masked Card number used
Price, description, and fees all shown separately
Authorization Code (returned as provider_approval_code)
Merchant name and contact information
Card Network (returned as provider_network)
Refund/Return policy
Transaction Type: ex: Purchase, Disbursement, Credit, Cancellation, Refund, Return, Prepaid Load

Callback Option

Every transaction request can include callback_url and callback_params in the root object of the request
callback_params is a string array with the optional values:
transaction_id, request_reference_id and transaction_status
The callback URL will be invoked after the transaction process is complete or the status of a transaction changes.

\n","event":[{"listen":"prerequest","script":{"id":"88cb9a44-722f-45b6-a7df-627e91a73c64","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"0bd077f9-12ba-4277-9541-9a38a9949167","type":"text/javascript","exec":[""]}}],"_postman_id":"7c843cd9-42ae-4b5c-ae1f-2d7afacaa8cd","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}]},"isInherited":true,"source":{"_postman_id":"7815deea-f46d-4e86-aa69-68eeda68f98f","id":"7815deea-f46d-4e86-aa69-68eeda68f98f","name":"Interchecks RESTful API v1","type":"collection"}}}],"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}]}},"event":[{"listen":"prerequest","script":{"id":"7f93870e-9ab1-4761-92c6-c4bd4aa52e2e","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"bdd16a61-970b-42df-a6d2-6b78daee9b18","type":"text/javascript","exec":[""]}}],"variable":[{"key":"url","value":"https://test.interchecks.com"}]}

Latest News

01-07-2021

API V2 Documentation

09-09-2021

Production URL Updates

05-26-2020

URL Housekeeping

10-09-2018

Widget UI for CARD collection

Payment Transactions

08-29-2019

DEBIT updated to CARD

Environments

Development/Sandbox: https://test.interchecks.com

Production: Contact tech@interchecks.com for the production URL

Authentication

Response Codes

Error Structure

Error Codes

Workflows

Payouts

Payment with Widget/UI

Payment with Payout

Payment Transaction

Test Debit/Credit Cards

API calls to manage recipients

Required/Optional payload fields for each Account Type below.

Account API calls to facilitate Payouts and Transactions and manage recipient accounts

Create a Payment for Portal Acceptance

Payment UI URL

Paying with an Account ID

Required/Optional fields for Payout method

Required/Optional fields for Payout methods

Required/Optional fields for Payout methods

Paying with a Card Number - Important

Required/Optional fields for Payout method

Payment Bundling

Payment Request Information

Callback Option

Payout Request

Required/Optional fields for Payout methods

Required/Optional Params

Card Processing Providers often require the display of certain information pre and post transaction

Callback Option

Widget UI for `CARD` collection