Skip to main content

Retrieve a transfer

GET 
/transfers/:transfer_id

Retrieve a transfer

Request​

Path Parameters

    transfer_id uuidrequired

Responses​

Transfer retrieved

Schema

    status string

    Possible values: [success]

    data

    object

    Provider/rail internals (provider, provider_transfer_id, return_code, failure_reason) are only present for admin/partner viewers. On the incoming side of an internal transfer some fields are hidden and direction/counterparty are added.

    id uuid

    The transfer id.

    initiator_account_id uuid

    Account that initiated the transfer (the source payment method's owner).

    status string

    Possible values: [posted, pending, dispatched, settled, returned, failed]

    posted = internal wallet→wallet, instant & final. Bank legs are born pending → dispatched → settled (final), or returned/failed.

    amount integer

    Smallest currency unit.

    amount_currency string

    ISO 4217 currency code of the amount.

    source

    object

    Resolved source endpoint (wallet or bank account).

    kind string

    Possible values: [wallet, bank_account]

    account_id uuid
    currency stringnullable

    Set for wallet endpoints.

    payment_method_id uuidnullable

    Set for bank-account endpoints.

    instrument

    object

    nullable

    Immutable snapshot of the bank instrument used, captured at transfer creation. Present only for bank endpoints. Wallet endpoints omit it.

    bank_name stringnullable
    last4 stringnullable
    account_type stringnullable
    account_holder_type stringnullable
    holder_name stringnullable

    destination

    object

    Resolved destination endpoint (wallet or bank account).

    kind string

    Possible values: [wallet, bank_account]

    account_id uuid
    currency stringnullable

    Set for wallet endpoints.

    payment_method_id uuidnullable

    Set for bank-account endpoints.

    instrument

    object

    nullable

    Immutable snapshot of the bank instrument used, captured at transfer creation. Present only for bank endpoints. Wallet endpoints omit it.

    bank_name stringnullable
    last4 stringnullable
    account_type stringnullable
    account_holder_type stringnullable
    holder_name stringnullable
    reference stringnullable

    Merchant-facing reference, if set.

    metadata

    object

    nullable

    Arbitrary key/value pairs supplied on creation.

    property name* anynullable

    Arbitrary key/value pairs supplied on creation.

    category string

    Possible values: [cash_out, deposit, internal, external]

    Server-computed semantic type of the transfer. cash_out/deposit are self-movements (wallet↔own bank) and suppress counterparty.

    direction string

    Possible values: [outgoing, incoming]

    Relative to the viewer; present on list/retrieve.

    counterparty

    object

    nullable

    The other party, from the viewer's perspective (present on retrieve/list).

    name string
    type string

    Possible values: [business, individual, unknown]

    Counterparty account class as shown to the viewer. business covers merchant/partner accounts; unknown when it cannot be resolved.

    created_on integer

    Unix timestamp (seconds) when the transfer was created.

    dispatched_on integernullable

    Unix timestamp (seconds) when handed to the bank rail, or null.

    settled_on integernullable

    Unix timestamp (seconds) when settled, or null.

    returned_on integernullable

    Unix timestamp (seconds) when returned, or null.

    failed_on integernullable

    Unix timestamp (seconds) when it failed, or null.

    failure_reason stringnullable

    Why the transfer failed (e.g. a provider rejection). Provider-internal — present only for admin/partner viewers.

    code integer

    Possible values: [200]

    message string

    Possible values: [Successful request]

Loading...