Pular para o conteúdo principal
List Transfers
Use este endpoint para recuperar todas as transferências associadas à sua conta SpherePay. Você pode restringir os resultados por cliente, status da transferência ou tipo de transferência. Os resultados são paginados — use os parâmetros page e limit para percorrer conjuntos de resultados grandes.

Autorizações

Authorization
string
header
obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Parâmetros de consulta

page
string
padrão:1
obrigatório

Page number of the list (default: 1)

Exemplo:

1

limit
string
padrão:10
obrigatório

Number of items per page (default: 10)

Exemplo:

10

customer
string

Query by Customer ID.

Exemplo:

"customer_123abc..."

status
enum<string>

Query by Payout status. See Transfer Lifecycle for status definitions.

Opções disponíveis:
pendingFunding,
pendingReview,
fundsReceived,
processing,
succeeded,
undeliverable,
returned,
pendingRefundInformation,
failed,
canceled,
refunded,
unexpectedError,
failedPrecondition,
expired
Exemplo:

"succeeded"

type
enum<string>

Query by Payout type.

Opções disponíveis:
offRamp,
onChain,
onRamp,
microdeposit,
unmatchedDeposit
Exemplo:

"onRamp"

sort
string
padrão:-created
obrigatório

Comma-separated sort fields. Prefix with "-" for descending, "+" (or no prefix) for ascending. Allowed fields: created, updated, status, type, amount. Example: "type,-created".

Exemplo:

"-created"

Resposta

data
object[]
obrigatório

Array of transfer objects.

Exemplo:
pagination
object
obrigatório
Última modificação em 22 de junho de 2026