List all send instructions

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": [
    {
      "bank_account_id": 1,
      "amount": 12.44,
      "email": "[email protected]",
      "description": "Example Description",
      "reference": "abc",
      "id": 1,
      "state": "received",
      "receipt_url": "https://www.chip-in.asia/receipts/send/95712b0c",
      "slug": "95712b0c",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "pagination": {
      "current_page": 1,
      "prev_page": null,
      "next_page": null,
      "total_pages": 1,
      "total_count": 1
    }
  }
}

GET

send

send_instructions

List all send instructions

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": [
    {
      "bank_account_id": 1,
      "amount": 12.44,
      "email": "[email protected]",
      "description": "Example Description",
      "reference": "abc",
      "id": 1,
      "state": "received",
      "receipt_url": "https://www.chip-in.asia/receipts/send/95712b0c",
      "slug": "95712b0c",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "pagination": {
      "current_page": 1,
      "prev_page": null,
      "next_page": null,
      "total_pages": 1,
      "total_count": 1
    }
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

epoch

integer<Unix timestamp (seconds)>

required

Unix epoch timestamp Unix timestamp (seconds)

Example:

1619740800

checksum

string

required

Refer to checksum calculation

Response

Successful response

results

object[]

Show child attributes

results.bank_account_id

integer<int64>

required

ID that have been given in Add Bank Account

Example:

1

results.amount

string

required

Amount in floating point with maximum of 2 decimal places.

Example:

12.44

results.email

string<email>

required

Example:

"[email protected]"

results.description

string

required

Example:

"Example Description"

results.reference

string

required

Can be any value.

Example:

"abc"

results.id

integer<int64>

This ID must be stored for future reference.

Example:

1

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

string

Generated receipt url link

Example:

"https://www.chip-in.asia/receipts/send/95712b0c"

results.slug

string

Generated receipt url slug

Example:

"95712b0c"

results.created_at

string<date-time>

Object creation time in UTC

results.updated_at

string<date-time>

Object updated time

API Reference

Accounts

Send Limits

Bank Accounts

Send Instructions

Groups

Webhooks

List all send instructions

Authorizations

Headers

Response