Initiate a transfer of funds #
Initiate a transfer of funds from source entity to destination entity.
Authorizations
bearer
HTTP: bearer #
HTTP Authorization Scheme: bearer
Bearer format: JWT
| Authorization required | stringBearer token (API Key or OAuth2 Access Token). |
| Cko-Idempotency-Key required | stringAn idempotency key for safely retrying transfer requests. |
Request Body schema: application/json #
Request body for initiating a transfer of funds.
| transfer_type required | string Enum:”commission””promotion””refund”The type of transfer. |
| source required | objectThe object representing the source of the funds involved in the transfer. |
| destination required | objectThe object representing the destination of the funds involved in the transfer. |
| reference | string <= 50 characters A reference you can use later to identify this transfer (max 50 chars). |
Responses #
201 Transfer successfully created.
Response Schema: application/json #
| id required | stringThe id representing the initiated transfer. |
| status required | string Enum:”pending””completed””rejected”The current state of the initiated transfer. |
| _links required | objectLinks related to the transfer. |
400 Bad Request
Response Schema: application/json #
| request_idrequired | stringThe unique request identifier. |
| error_typerequired | stringThe error type. |
| error_codesrequired | Array of stringsThe error codes. |
401 Unauthorized
422 Invalid data was sent.
Response Schema: application/json #
| request_idrequired | stringThe unique request identifier. |
| error_typerequired | stringThe error type. |
| error_codesrequired | Array of stringsThe error codes. |
Retrieve a transfer #
Retrieve transfer details using the transfer identifier.
Authorizations
bearer
HTTP: bearer #
HTTP Authorization Scheme: bearer
Bearer format: JWT
path Parameters #
| idr equired | string Example: tra_y3oqhf46pyzuxjbcn2giaqnb4The transfer identifier. |
| Authorization required | string |
Responses #
200 Transfer found
Response Schema: application/json #
| idrequired | stringThe transfer identifier. |
| referencerequired | stringA unique reference used to identify this transfer. |
| statusrequired | string Enum:”pending””completed””rejected”The current state of the initiated transfer. |
| transfer_typerequired | string Enum:”commission””promotion””refund”The type of transfer. |
| requested_onrequired | stringThe date the transfer was requested on. |
| reason_codes | Array of stringsAn optional set of reason codes describing why the transfer is in its current state. |
| sourcerequired | objectThe source of the funds involved in the transfer. |
| destinationrequired | objectThe destination of the funds involved in the transfer. |
| _linksrequired | objectLinks related to the transfer. |
400 Bad Request
Response Schema: application/json #
| request_idrequired | stringThe unique request identifier. |
| error_typerequired | stringThe error type. |
| error_codesrequired | Array of stringsThe error codes. |
401 Unauthorized
404 Transfer not found
Response Schema: application/json #
| request_idrequired | stringThe unique request identifier. |
| error_typerequired | stringThe error type. |
| error_codesrequired | Array of stringsThe error codes. |
422 Invalid data was sent
Response Schema: application/json #
| request_idrequired | stringThe unique request identifier. |
| error_typerequired | stringThe error type. |
| error_codesrequired | Array of stringsThe error codes. |
EN 
ZH 
