Pular para o conteúdo principal
List Transfers
curl --request GET \
  --url https://api.spherepay.co/v2/transfer \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "payout_a1b2c3d4e5f6a7b8c9d0e1f2",
      "type": "on_ramp",
      "status": "succeeded",
      "customer": "customer_f31121c389624d3697cbf3ea8830b7a4",
      "externalId": "merchant_ref_123",
      "source": {
        "id": "bankAccount_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
        "type": "bank_account"
      },
      "destination": {
        "id": "wallet_e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2",
        "type": "wallet",
        "currency": "usdc",
        "network": "sol",
        "amount": "498.50",
        "exchangeRate": "1.00"
      },
      "created": "2026-04-01T10:00:00.000Z",
      "updated": "2026-04-01T10:12:00.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 1,
    "totalPages": 1,
    "hasNext": false,
    "hasPrevious": false
  }
}
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"

Resposta

data
object[]
obrigatório

Array of transfer objects.

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