Recuperar una Transferencia con Instrucciones 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"
}

Usa este endpoint para obtener los detalles completos de una transferencia única por su ID único. La respuesta incluye el estado actual, los recursos de origen y destino, el desglose de comisiones, las instrucciones de depósito para transferencias on-ramp y los identificadores de seguimiento a nivel de red una vez que la transferencia ha sido procesada. Consulta este endpoint o usa webhooks para monitorear las transiciones de estado a lo largo del ciclo de vida de la transferencia.

Autorizaciones

Authorization

string

header

requerido

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

Parámetros de ruta

string

requerido

The payout ID.

Ejemplo:

"payout_d243ab2b1de4447d8a046d87fefe58cf"

Respuesta

string

requerido

A unique identifier for transfer.

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

Ejemplo:

"payout_a1b2c3d4e5f6a7b8c9d0e1f2"

type

enum<string>

requerido

The transfer type.

Opciones disponibles:

on_ramp,

off_ramp,

unmatched_deposit

Ejemplo:

"on_ramp"

status

enum<string>

requerido

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

Opciones disponibles:

pendingFunding,

pendingReview,

fundsReceived,

processing,

succeeded,

undeliverable,

returned,

pendingRefundInformation,

failed,

canceled,

refunded,

unexpectedError,

failedPrecondition,

expired

Ejemplo:

"pendingFunding"

customer

string

requerido

The customer ID.

Ejemplo:

"customer_b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7"

source

Source Bank Account · object

requerido

The source of an on ramp transfer.

Source Bank Account
Source Wallet

Show child attributes

Ejemplo:

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

destination

Destination Wallet · object

requerido

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

Destination Wallet
Destination Bank Account

Show child attributes

depositAccount

Deposit Bank Account · object

requerido

The deposit bank account for an on ramp transfer.

Deposit Bank Account
Deposit Wallet

Show child attributes

updated

string<date-time>

requerido

The last datetime the transfer was updated.

Ejemplo:

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

created

string<date-time>

requerido

The datetime the transfer was created.

Ejemplo:

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

tracking

object

requerido

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).

Ejemplo:

"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 modificación el 18 de junio de 2026

Listar Transferencias Cancelar Transferencia

⌘I