Creating Transactions
Checking Routes
Section titled “Checking Routes”Before sending an InstaPay transaction, a route check must be done to determine if the recipient is reachable.
The route check will confirm:
- If the receiving bank or account supports InstaPay
- What type of payments are allowed (max amount, currency, etc.)
- Whether the destination is reachable
Option 1: By Card Number
Section titled “Option 1: By Card Number”To check if InstaPay supports a specific route by card number, use the following endpoint:
POST /api/v3/InstantRoutes/companycode/{companyCode}
Request Body
Section titled “Request Body”Example:
{ "cardNumber": "955096755978307371"}
Option 2: By Token’s PAN (Primary account number)
Section titled “Option 2: By Token’s PAN (Primary account number)”To check if InstaPay supports a specific route by a token’s PAN, use the following endpoint:
POST /api/v3/InstantRoutes/companycode/{companyCode}/token
Request Body
Section titled “Request Body”Example:
{ "tokenId": "string", "yourSubClientId": "string"}
Add an InstaPay Transaction
Section titled “Add an InstaPay Transaction”To add a transaction that will be funded instantly, use the following endpoint:
POST /api/v3/InstantTransactions/companycode/{companyCode}
Request Body
Section titled “Request Body”{ "nameOnCard": "OD1eXE", "cardNumber": "70363549677829755", "cardExpiration": "03/2021", "tokenId": "string", "yourSubClientId": "string", "totPassword": "368834", "amount": 100000, "yourReferenceNumber": "btLm"}