List all Transfers

Authorizations

Authorization

string

headerrequired

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Query Parameters

limit

integer

A limit on the number of objects to be returned, between 1 and 100.

starting_after

string

A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with aaa, your subsequent call can include starting_after=aaa in order to fetch the next page of the list.

ending_before

string

A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with aaa, your subsequent call can include ending_before=aaa in order to fetch the previous page of the list.

user_id

string

Include only results with this user ID attached.

type

string

Filter transfers by type.

status

string

Filter transfers by status.

start_date

string

Filter transfers by start date.

end_date

string

Filter transfers by end date.

Response

200 - application/json

has_more

boolean

true if there are more transfers.

data

object[]

Array of transfers.

data.id

string

data.created

string

data.user_id

string

data.status

enum<string>

Available options:

created,

pending,

failed,

completed,

reversed,

canceled,

flagged

data.type

enum<string>

Available options:

refill,

payout,

balance

data.amount

number

data.external_data

object

data.transactions

object[]

data.transactions.id

integer

data.transactions.amount

number

data.transactions.created

string

data.transactions.source_name

string

data.transactions.destination_name

string

data.transactions.type

enum<string>

The general category of the transaction

Available options:

balance,

refill,

payout,

payment,

fee,

surrogate

data.transactions.metadata

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

data.transactions.transfer_id

string

ID of the transfer that the transaction belongs to.

data.transactions.transfer

object

The transfer that the transaction belongs to. This is only present if include_transfer is true.

data.transactions.transfer.id

string

data.transactions.transfer.created

string

data.transactions.transfer.user_id

string

data.transactions.transfer.status

enum<string>

Available options:

created,

pending,

failed,

completed,

reversed,

canceled,

flagged

data.transactions.transfer.type

enum<string>

Available options:

refill,

payout,

balance

data.transactions.transfer.amount

number

data.transactions.transfer.external_data

object

data.transactions.transfer.transactions

object[]

data.transactions.transfer.payout_link_id

string

ID of the payout-link that the transfer belongs to.

data.transactions.transfer.metadata

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

data.payout_link_id

string

ID of the payout-link that the transfer belongs to.

data.metadata

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

Add User Address Create a Transfer

users

transfers

flows

payout-links

payouts

payments

payout-requests

transactions

payment-intents

transfer-batches

payment-customers

checkout-sessions

apps

payment-methods

disputes

refunds

List all Transfers

Authorizations

Query Parameters

Response