CHcheckout
Transfers

Retrieve a transfer

Retrieve transfer details using the transfer identifier.

get/transfers/{id}

Request

Path parameters

idstring required

The transfer identifier

Response

Transfer found

idstring

The transfer identifier

referencestring

A unique reference used to identify this transfer

status'pending' | 'completed' | 'rejected'

The current state of the initiated transfer.

transfer_type'commission' | 'promotion' | 'refund'

The type of transfer

requested_onstring

The date the transfer was requested on

reason_codesstring[]

An optional set of reason codes describing why the transfer is in its current state

Example response

{
  "id": "tra_y3oqhf46pyzuxjbcn2giaqnb4",
  "reference": "superhero1234",
  "status": "rejected",
  "transfer_type": "commission",
  "requested_on": "2021-12-15T09:15:02.3845763Z",
  "reason_codes": [
    "destination_transfers_capability_disabled",
    "source_and_destination_currency_accounts_must_be_different"
  ],
  "source": {
    "entity_id": "ent_azsiyswl7bwe2ynjzujy7lcjca",
    "amount": 100,
    "currency": "GBP"
  },
  "destination": {
    "entity_id": "ent_bqik7gxoavwhmy3ot6kvmbx6py"
  },
  "_links": {
    "self": {
      "href": "https://transfers.checkout.com/transfers/tra_y3oqhf46pyzuxjbcn2giaqnb4"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.