CHcheckout
Transfers

Initiate a transfer of funds

Initiate a transfer of funds from source entity to destination entity.

post/transfers

Request

Headers

Cko-Idempotency-Keystring required

An idempotency key for safely retrying transfer requests

Request body

referencestring

A reference you can use later to identify this transfer

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

The type of transfer

Example request

{
  "reference": "superhero1234",
  "source": {
    "id": "ent_azsiyswl7bwe2ynjzujy7lcjca",
    "amount": 100,
    "currency": "GBP"
  },
  "destination": {
    "id": "ent_w4jelhppmfiufdnatam37wrfc4"
  }
}

Response

Transfer successfully created.

idstring

The id representing the initiated transfer.

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

The current state of the initiated transfer.

Example response

{
  "id": "tra_y3oqhf46pyzuxjbcn2giaqnb4",
  "_links": {
    "self": {
      "href": "https://transfers.checkout.com/transfers/tra_y3oqhf46pyzuxjbcn2giaqnb4"
    }
  }
}

Changes

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