Saltar al contenido principal
Cancel a Transfer
curl --request DELETE \
  --url https://api.spherepay.co/v2/transfer/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "payout_d243ab2b1de4447d8a046d87fefe58cf",
  "externalId": "merchant_ref_123",
  "type": "on_ramp",
  "status": "canceled",
  "customer": "customer_f31121c389624d3697cbf3ea8830b7a4",
  "fees": {
    "integratorFee": {
      "fixedAmount": "0.00",
      "bpsRate": "25",
      "bpsAmount": "0.00",
      "totalAmount": "0.00",
      "currency": "usd"
    },
    "platformFee": {
      "fixedAmount": "0.00",
      "bpsRate": "10",
      "bpsAmount": "0.00",
      "totalAmount": "0.00",
      "currency": "usd"
    }
  },
  "source": {
    "id": "bankAccount_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
    "type": "bank_account"
  },
  "destination": {
    "id": "wallet_e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0",
    "type": "wallet",
    "currency": "usdc",
    "network": "sol",
    "amount": "0.00",
    "exchangeRate": "1.00"
  },
  "depositAccount": {
    "type": "bank_account",
    "bankDetails": {
      "bankName": "Bank of America",
      "accountHolderName": "SpherePay Inc.",
      "accountType": "checking",
      "accountNumber": "1234567890",
      "routingNumber": 26009593,
      "memo": "BBE6C7EB4A3F"
    }
  },
  "quote": null,
  "tracking": {
    "source": {},
    "destination": {}
  },
  "created": "2026-04-01T10:00:00.000Z",
  "updated": "2026-04-01T10:03:15.000Z"
}
Usa este endpoint para cancelar una transferencia antes de que se hayan recibido fondos. La cancelación solo es posible mientras la transferencia está en estado pendingFunding — una vez que SpherePay detecta un depósito entrante y la transferencia avanza a fundsReceived o más allá, ya no puede ser cancelada. Si los fondos llegan después de la cancelación, SpherePay intentará devolverlos y la transferencia puede transicionar a returned o pendingRefundInformation.
No puedes cancelar una transferencia que esté en cualquier estado distinto a pendingFunding. Verifica el estado de la transferencia con GET /v2/transfer/ antes de intentar la cancelación.

Autorizaciones

Authorization
string
header
requerido

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

Parámetros de ruta

id
string
requerido

Respuesta

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

Ejemplo:
{
"id": "bankAccount_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
"type": "bank_account"
}
destination
Destination Wallet · object
requerido

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

depositAccount
Deposit Bank Account · object
requerido

The deposit bank account for an on ramp transfer.

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.

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.

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.

Última modificación el 18 de junio de 2026