Get Transfer Details

The GET /international-transfers/v1/transfers/{id} method enables you to retrieve the details of an international transfer and its updated state. Then, after submitting the transfer quote, you can use this method to poll the transfer and determine its status.

International transfers can be in one of six possible states:

  • CREATED: This initial stage signals the system has received the transfer request and has created the transaction but has yet to initiate the transfer.
  • PROCESSING: The system has started the transfer and is in the process of transferring the funds.
  • COMPLETED: The transfer has been confirmed. Funds are in the target account.
  • IN_REVIEW: The system encountered a problem that triggered a retry. Bitso's Partnerships team might contact the customer.
  • FAILED: For some reason, the transfer failed. At this stage of development of the API, the funds can finish in the target account, or a refund takes place. Bitso's Partnerships team will contact the customer.
  • REFUNDED: A refund to the source account took place.

To retrieve the details of a given transfer, make the following HTTP request using the specified path parameter:

GET https://api-stage.bitso.com/international-transfers/v1/transfers/{id}

Path Parameter

  • id: Identifies the transfer whose status you want to know; the execute transfer call returns this variable.

The following response object exemplifies the JSON object returned:

{
    "success": true,
    "payload": {
        "id": "290",
        "quote_id": "Lm69qqq1",
        "status": "IN_REVIEW",
        "created": "2023-07-11T23:14:49",
        "updated": "2023-07-11T23:14:54"
    }
}