Recuperar uma Transferência com Instruções de Depósito

Retrieve a Transfer

curl --request GET \
  --url https://api.spherepay.co/v2/transfer/{id} \
  --header 'Authorization: Bearer <token>'

{
  "id": "payout_d243ab2b1de4447d8a046d87fefe58cf",
  "externalId": "merchant_ref_123",
  "type": "on_ramp",
  "status": "pendingFunding",
  "customer": "customer_f31121c389624d3697cbf3ea8830b7a4",
  "fees": {
    "integratorFee": {
      "fixedAmount": "1.00",
      "bpsRate": "10",
      "bpsAmount": "0.50",
      "totalAmount": "1.50",
      "currency": "usd"
    },
    "platformFee": {
      "fixedAmount": "2.00",
      "bpsRate": "10",
      "bpsAmount": "0.50",
      "totalAmount": "2.50",
      "currency": "usd"
    }
  },
  "source": {
    "id": "bankAccount_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
    "type": "bank_account"
  },
  "destination": {
    "id": "wallet_e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2",
    "type": "wallet",
    "currency": "usdc",
    "network": "sol",
    "amount": "496.00",
    "exchangeRate": "1.00"
  },
  "depositAccount": {
    "type": "bank_account",
    "bankDetails": {
      "bankName": "Bank of America",
      "accountHolderName": "SpherePay Inc.",
      "accountType": "checking",
      "accountNumber": "1234567890",
      "routingNumber": 26009593,
      "bic": "BOFAUS3N",
      "iban": null,
      "pixKey": null,
      "brCode": null,
      "bankAddress": "100 N Tryon St, Charlotte, NC 28202, USA",
      "beneficiaryAddress": "350 Mission St, San Francisco, CA 94105, USA",
      "memo": "BBE6C7EB4A3F"
    }
  },
  "quote": {
    "id": "quote_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
    "expiresAt": "2026-04-01T10:15:00.000Z"
  },
  "tracking": {
    "source": {
      "imad": "20260401BOFAUS3N000042",
      "omad": "20260401BOFAUS3N000042000001",
      "traceNumber": 26009591234567,
      "transactionId": null,
      "uetr": null
    },
    "destination": {
      "imad": null,
      "omad": null,
      "traceNumber": null,
      "transactionId": "4a5b6c7d8e9f0a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2e3f4a5b",
      "uetr": null
    }
  },
  "created": "2026-04-01T10:00:00.000Z",
  "updated": "2026-04-01T10:05:30.000Z"
}

Retrieve a Transfer

curl --request GET \
  --url https://api.spherepay.co/v2/transfer/{id} \
  --header 'Authorization: Bearer <token>'

{
  "id": "payout_d243ab2b1de4447d8a046d87fefe58cf",
  "externalId": "merchant_ref_123",
  "type": "on_ramp",
  "status": "pendingFunding",
  "customer": "customer_f31121c389624d3697cbf3ea8830b7a4",
  "fees": {
    "integratorFee": {
      "fixedAmount": "1.00",
      "bpsRate": "10",
      "bpsAmount": "0.50",
      "totalAmount": "1.50",
      "currency": "usd"
    },
    "platformFee": {
      "fixedAmount": "2.00",
      "bpsRate": "10",
      "bpsAmount": "0.50",
      "totalAmount": "2.50",
      "currency": "usd"
    }
  },
  "source": {
    "id": "bankAccount_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
    "type": "bank_account"
  },
  "destination": {
    "id": "wallet_e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2",
    "type": "wallet",
    "currency": "usdc",
    "network": "sol",
    "amount": "496.00",
    "exchangeRate": "1.00"
  },
  "depositAccount": {
    "type": "bank_account",
    "bankDetails": {
      "bankName": "Bank of America",
      "accountHolderName": "SpherePay Inc.",
      "accountType": "checking",
      "accountNumber": "1234567890",
      "routingNumber": 26009593,
      "bic": "BOFAUS3N",
      "iban": null,
      "pixKey": null,
      "brCode": null,
      "bankAddress": "100 N Tryon St, Charlotte, NC 28202, USA",
      "beneficiaryAddress": "350 Mission St, San Francisco, CA 94105, USA",
      "memo": "BBE6C7EB4A3F"
    }
  },
  "quote": {
    "id": "quote_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
    "expiresAt": "2026-04-01T10:15:00.000Z"
  },
  "tracking": {
    "source": {
      "imad": "20260401BOFAUS3N000042",
      "omad": "20260401BOFAUS3N000042000001",
      "traceNumber": 26009591234567,
      "transactionId": null,
      "uetr": null
    },
    "destination": {
      "imad": null,
      "omad": null,
      "traceNumber": null,
      "transactionId": "4a5b6c7d8e9f0a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2e3f4a5b",
      "uetr": null
    }
  },
  "created": "2026-04-01T10:00:00.000Z",
  "updated": "2026-04-01T10:05:30.000Z"
}

Use este endpoint para buscar os detalhes completos de uma única transferência pelo seu ID único. A resposta inclui o status atual, os recursos de origem e destino, detalhamento de taxas, instruções de depósito para transferências on-ramp e identificadores de rastreamento a nível de rede uma vez que a transferência tenha sido processada. Consulte este endpoint ou use webhooks para monitorar transições de status ao longo do ciclo de vida da transferência.

Autorizações

Authorization

string

header

obrigatório

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

Parâmetros de caminho

string

obrigatório

The payout ID.

Exemplo:

"payout_d243ab2b1de4447d8a046d87fefe58cf"

Resposta

string

obrigatório

A unique identifier for transfer.

Pattern: ^payout_[a-z0-9]{24}$

Exemplo:

"payout_a1b2c3d4e5f6a7b8c9d0e1f2"

type

enum<string>

obrigatório

The transfer type.

Opções disponíveis:

on_ramp,

off_ramp,

unmatched_deposit

Exemplo:

"on_ramp"

status

enum<string>

obrigatório

The transfer status. See Transfer Lifecycle for status definitions and transitions.

Opções disponíveis:

pendingFunding,

pendingReview,

fundsReceived,

processing,

succeeded,

undeliverable,

returned,

pendingRefundInformation,

failed,

canceled,

refunded,

unexpectedError,

failedPrecondition,

expired

Exemplo:

"pendingFunding"

customer

string

obrigatório

The customer ID.

Exemplo:

"customer_b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7"

source

Source Bank Account · object

obrigatório

The source of an on ramp transfer.

Source Bank Account
Source Wallet

Show child attributes

Exemplo:

{
  "id": "bankAccount_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
  "type": "bank_account"
}

destination

Destination Wallet · object

obrigatório

The destination of an On-ramp transfer. See Wallets for registration.

Destination Wallet
Destination Bank Account

Show child attributes

depositAccount

Deposit Bank Account · object

obrigatório

The deposit bank account for an on ramp transfer.

Deposit Bank Account
Deposit Wallet

Show child attributes

updated

string<date-time>

obrigatório

The last datetime the transfer was updated.

Exemplo:

"2021-01-01T00:00:00.000Z"

created

string<date-time>

obrigatório

The datetime the transfer was created.

Exemplo:

"2021-01-01T00:00:00.000Z"

tracking

object

obrigatório

Tracking references for the transfer. Only included when at least one reference exists.

Show child attributes

externalId

string

The external reference (not stored as unique).

Exemplo:

"merchant_ref_123"

fees

object

Fee breakdown for the transfer. For floating-rate BRL transfers, this is omitted until settlement is complete.

Show child attributes

quote

object

The quote used for this transfer, if any. When present, the locked exchange rate from the quote was applied to the destination amount and exchange rate.

Show child attributes

Última modificação em 18 de junho de 2026

Listar Transferências Cancelar Transferência

⌘I