Skip to main content
GET
Get a transfer
One transfer, in this credential’s mode. A transfer waiting on you reads status: pending and substatus: awaiting_collection, with the collection_deadline you have to confirm it by.

Authorizations

Authorization
string
header
required

A platform access token. Get one on the Create an access token endpoint by exchanging your client_id + client_secret, then send it as Authorization: Bearer <token>. Tokens live one hour.

Path Parameters

transfer_id
string
required

Response

The transfer.

object
enum<string>
required

Always company_wallet_transfer.

Available options:
company_wallet_transfer
id
string
required
status
enum<string>
required

pending until the money reaches the card, funded once it has, consumed once the card holds it, reclaimed once a closed card gave it back, failed when it never moved.

Available options:
pending,
funded,
consumed,
reclaimed,
failed
substatus
string
required

Where a pending transfer is: awaiting_collection (waiting on you), collection_confirmed or transferring.

kind
string
required

mint for a new card, top_up for a raise on an existing one.

user_id
string | null
required

The user the card is for.

amount_cents
integer
required

What the card asked for.

livemode
boolean
required

false on a sandbox credential.

created_at
string<date-time>
required
card_id
string | null

The card the transfer made or raised.

fee_cents
integer

The fee on top.

transferred_cents
integer

What has moved so far.

released_cents
integer

What a closed card gave back. It counts toward the user's next card until you recover it.

failure_reason
string | null

Why a failed transfer failed.

collection_deadline
string | null

When a transfer waiting on you fails if you haven't confirmed it.