POST
/
send
/
send_instructions

Authorizations

Authorization
string
headerrequired

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

Headers

epoch
integer
required

Unix epoch timestamp

checksum
string
required

Refer to checksum calculation

Body

application/json
bank_account_id
integer
required

ID that have been given in Add Bank Account

amount
string
required

Amount in floating point with maximum of 2 decimal places.

email
string
required
description
string
required
reference
string
required

Can be any value.

Response

200 - application/json
id
integer

This ID must be stored for future reference.

bank_account_id
integer
required

ID that have been given in Add Bank Account

amount
string
required

Amount in floating point with maximum of 2 decimal places.

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
email
string
required
description
string
required
reference
string
required

Can be any value.

receipt_url
string

Generated receipt url link

slug
string

Generated receipt url slug

created_at
string

Object creation time in UTC

updated_at
string

Object updated time

Resend bank account webhook eventRetrieve a send instruction