[3] Instruct Deal
Header Parameters
application/json
{insert Client-level "access_code"}
Path Parameters
A unique 6-digit client identifier for each client account.
Body Parameters
Client-generated unique idempotency key for the request. For compatibility, it is recommended to provide a GUID value.
Details of the order
Show child attributes
Beneficiary Payment Details
Show child attributes
Beneficiary Settlement Details
Show child attributes
Response
Response Attributes
Show child attributes
SELF LINKS
Show child attributes
Response Attributes
Show child attributes
SELF LINKS
Show child attributes
Response Attributes
An array containing error objects, including error codes and the message
Show child attributes
Show child attributes
Response Attributes
Show child attributes
Show child attributes
Response Attributes
Show child attributes
Response Attributes
Show child attributes
What made this section unhelpful for you?
Response
Error Codes
400
Incorrect settlement account / incorrect 'deliveryMethod' Either the Client does not have the permission set to settle with this account type, or the account identifier provided in the request is incorrect.
400
Incorrect bene / incorrect 'deliveryMethod' Could be one of the following: The beneficiary identifier provided in the request is incorrect (the 'clientIntegrationId' or 'id'). The bene does not exist (so the 'id' or 'clientIntegrationId' you are using is invalid).
400
Invalid / already-instructed Order Number The order number has already been instructed, or it doesn't belong to your account.
400
Amount exceeds Spot balance The order does not contain the funds available to pay the beneficiary. A top-up is not possible.
What made this section unhelpful for you?