Send Instructions
List all send instructions
- Introduction
- GETList all accounts
- POSTIncrease Budget Allocation
- GETRetrieve send limit
- GETList all send limits
- POSTResend approval request
- POSTAdd a bank account
- GETRetrieve a bank account
- DELDelete a bank account
- GETList all bank accounts
- POSTResend bank account webhook event
API Reference
Accounts
Send Limits
Bank Accounts
Send Instructions
List all send instructions
Returns a list of previously created send instructions.
Note: This request is cached and will only refresh every hour.
GET
/
send
/
send_instructions
Authorization
string
*
Bearer
Authorization
Required
string
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
epoch
integer
*
epoch
Required
integer
Unix epoch timestamp
Add Example Value
checksum
string
*
checksum
Required
string
Refer to checksum calculation
curl --request GET \
--url https://staging-api.chip-in.asia/api/send/send_instructions \
--header 'Authorization: Bearer <token>' \
--header 'checksum: <checksum>' \
--header 'epoch: <epoch>'{
"results": [
{
"id": 49,
"bank_account_id": 39,
"amount": "100.00",
"state": "received",
"email": "wan@chip-in.asia",
"description": null,
"reference": null,
"created_at": "2023-03-20T02:04:40.692Z",
"updated_at": "2023-03-20T02:04:40.692Z"
},
{
"id": 48,
"bank_account_id": 39,
"amount": "100.00",
"state": "received",
"email": "wan@chip-in.asia",
"description": "test",
"reference": null,
"created_at": "2023-03-20T02:04:37.218Z",
"updated_at": "2023-03-20T02:04:37.218Z"
},
{
"id": 45,
"bank_account_id": 39,
"amount": "100.00",
"state": "received",
"email": "wan@chip-in.asia",
"description": "test",
"reference": null,
"created_at": "2023-03-17T08:08:09.283Z",
"updated_at": "2023-03-17T08:08:09.283Z"
},
{
"id": 44,
"bank_account_id": 39,
"amount": "100.00",
"state": "received",
"email": "wan@chip-in.asia",
"description": "test",
"reference": null,
"created_at": "2023-03-17T08:07:50.038Z",
"updated_at": "2023-03-17T08:07:50.038Z"
}
],
"meta": {
"pagination": {
"current_page": 1,
"prev_page": null,
"next_page": null,
"total_pages": 1,
"total_count": 2
}
}
}Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
epoch
integer
requiredUnix epoch timestamp
checksum
string
requiredRefer to checksum calculation
Response
200 - application/json
results
object[]
results.id
integer
This ID must be stored for future reference.
results.bank_account_id
integer
requiredID that have been given in Add Bank Account
results.amount
string
requiredAmount in floating point with maximum of 2 decimal places.
results.state
enum<string>
received: This indicates that the instruction has been received. But, the processing has not been started.enquiring: This indicates that the instruction is pending verification.executing: This indicates that the instruction is pending execution.reviewing: This indicates that the instruction is requires further attention. Contact account manager for further troubleshooting.accepted: This indicates that the instruction has been accepted by service provider but not yet completed, commonly related to beneficiary bank's system outage during the request. Successful instructions will be set as completed within 24 hours, while unsuccessful instructions will require further checking before being set as rejected.completed: This indicates that the instruction has completed execution and the recipient should have received the payment.rejected: This indicates that the instruction has been rejected.deleted: This indicates that the instruction has been deleted.
Available options:
received, enquiring, executing, reviewing, accepted, completed, rejected, deleted results.email
string
requiredresults.description
string
requiredresults.reference
string
requiredCan be any value.
results.receipt_url
string
Generated receipt url link
results.slug
string
Generated receipt url slug
results.created_at
string
Object creation time in UTC
results.updated_at
string
Object updated time
meta
object
meta.pagination
object
This is pagination schema
meta.pagination.current_page
integer
Current page value
meta.pagination.prev_page
integer | null
Previous page value
meta.pagination.next_page
integer | null
Next page value
meta.pagination.total_pages
integer
Total available pagination
meta.pagination.total_count
integer
Total avaialable records
curl --request GET \
--url https://staging-api.chip-in.asia/api/send/send_instructions \
--header 'Authorization: Bearer <token>' \
--header 'checksum: <checksum>' \
--header 'epoch: <epoch>'{
"results": [
{
"id": 49,
"bank_account_id": 39,
"amount": "100.00",
"state": "received",
"email": "wan@chip-in.asia",
"description": null,
"reference": null,
"created_at": "2023-03-20T02:04:40.692Z",
"updated_at": "2023-03-20T02:04:40.692Z"
},
{
"id": 48,
"bank_account_id": 39,
"amount": "100.00",
"state": "received",
"email": "wan@chip-in.asia",
"description": "test",
"reference": null,
"created_at": "2023-03-20T02:04:37.218Z",
"updated_at": "2023-03-20T02:04:37.218Z"
},
{
"id": 45,
"bank_account_id": 39,
"amount": "100.00",
"state": "received",
"email": "wan@chip-in.asia",
"description": "test",
"reference": null,
"created_at": "2023-03-17T08:08:09.283Z",
"updated_at": "2023-03-17T08:08:09.283Z"
},
{
"id": 44,
"bank_account_id": 39,
"amount": "100.00",
"state": "received",
"email": "wan@chip-in.asia",
"description": "test",
"reference": null,
"created_at": "2023-03-17T08:07:50.038Z",
"updated_at": "2023-03-17T08:07:50.038Z"
}
],
"meta": {
"pagination": {
"current_page": 1,
"prev_page": null,
"next_page": null,
"total_pages": 1,
"total_count": 2
}
}
}