API testing guide
Testing Sandbox mode endpoints
Sandbox mode offers a comprehensive insight into the functionality of the Instant Cash (IC) Web API gateway. With Sandbox mode, you can make requests and observe the anticipated responses. However, only specific parameter values are compatible with this mode. Refer to the list of API endpoints available for sandbox testing:
| HTTP Method | Endpoint Name | Input Parameter Name (required marked with *) | Input Parameter Value |
|---|---|---|---|
| GET | GetBalance | n/a | |
| GET | GetExchangeRate | sendingAgent(*) | AE01BH |
| settlementCurrency(*) | AED | ||
| destinationCountry | PK | ||
| receivingAgent | PK01RH | ||
| GET | GetChargeSlab | sourceCurrency(*) | AED |
| targetCurrency(*) | PKR | ||
| originatingCountry(*) | AE | ||
| destinationCountry(*) | PK | ||
| deliveryMode(*) | 7 | ||
| sourceAmount | any | ||
| targetAmount | any | ||
| receivingAgent | PK01RH | ||
| GET | GetTransactionDetails | reference | 000000222 |
| partnerReference | |||
| GET | GetOutstandingRemittances | n/a | |
| POST | GenerateICTC | count (*) | any number from 1 to 999 |
| GET | GetTransactionList | n/a | |
| GET | Get Transaction Report | level (*) | H |
| fromDate* | 2023-11-01 | ||
| toDate* | 2024-01-11 | ||
| pageNumber | 1 | ||
| pageSize | 1000 | ||
| GET | ReceivePayment | reference | 000000222 |
| GET | GetAgentData | destinationCountry(*) | PH |
| deliveryMode(*) | 4 | ||
| state | |||
| bankName | |||
| pageNumber | 1 | ||
| pageSize | 1000 | ||
| GET | GetUpdatedAgentData | sendingAgentCountryCode (*) | AE |
| sendingAgentLocalCurrency (*) | AED | ||
| destinationCountry (*) | PK | ||
| deliveryMode (*) | 7 | ||
| updatedFrom (*) | 2022-01-O1 | ||
| GET | GetAnywherePayoutNetworks | receivingCountry(*) | AE |
| deliveryMode(*) | 7 | ||
| GET | GetBankBranches | receivingCountry(*) | AE |
| deliveryMode (*) | 4 | ||
| receivingAgentHeadOfficeCode(*) | AE01BH | ||
| pageNumber | 1 | ||
| pageSize | 1000 | ||
| GET | GetCities | countryCode | PH |
| stateCode | NCR | ||
| pageNumber | 1 | ||
| pageSize | 1000 | ||
| GET | GetModality | destinationCountryCode | AE |
| GET | GetReceivingCountries | countryCode | AE |
| GET | GetStates | countryCode | PK |
| pageNumber | 1 | ||
| pageSize | 1000 | ||
| GET | GetStaticData | filter (*) | remittance-purposes,source-of-funds,professions,relationships,employment-status,id-types,delivery-modes |
| GET | Get Ictc Payment Status | reference (*) | 000000222 |
| partnerReference | |||
| PUT | Simulation | reference (*) | 000000222 |
| new status (*) | Link | ||
| POST | CancelTransaction | reference (*) | 000000222 |
| reason (*) | Incorrect data | ||
| PATCH | ModifyTransaction | Recipes: Link | |
| POST | Create Transaction | Recipes: Link | |
| POST | ConfirmTransaction | Link | Guidelines: Link |
| POST | UnlockTransaction | reference (*) | Guidelines: Link |
| POST | AuthorizeTransaction | reference (*) | 222 |
| payingCurrency (*) | PKR | ||
| payingAmount (*) | 100 |
Updated 8 months ago