Skip to main content
A transfer (trf_*) moves money within one party: between its wallets, or between a wallet and a linked bank account. To learn more, see Deposit and withdraw and Transfer between wallets.

Example

GET /transfers/{transferId}
The object is everything inside data. The field names below are relative to it: attributes.type is data.attributes.type in the response.

Fields

string
required
Resource type. Always transfer.
string
required
Transfer ID (trf_*).
object
required
The transfer’s details.
object
required
Related resources, each by type and ID.

Statuses

Internal transfers

Internal transfers send no webhook events. Read status on the response.

Events

  • deposit.created: The public deposit transfer resource became visible. API-initiated deposits emit with status “created” once they pass approval checks, before money movement submission. Deposits denied or canceled by those checks don’t emit it; deposits discovered from money movement may emit with the current status, such as “processing”. Deposits carry no fee, so fee is always null on deposit.* events.
  • deposit.completed: A deposit reached the public completed state.
  • deposit.failed: A deposit failed during submit or money movement processing.
  • deposit.returned: An incoming deposit was returned by the bank.
  • deposit.canceled: A deposit was canceled before money movement processing.
  • deposit.approvalDenied: A deposit approval was explicitly denied before money movement processing.
  • withdrawal.created: A withdrawal was created and funds are being moved out of a wallet. Instant withdrawals carry a fee, assessed when the withdrawal is submitted, so it’s always null on withdrawal.created. Read it from withdrawal.completed.
  • withdrawal.completed: A withdrawal completed successfully.
  • withdrawal.failed: A withdrawal failed before settling.
  • withdrawal.returned: A settled withdrawal was returned or reversed.
  • withdrawal.canceled: A withdrawal was canceled before money movement processing.
  • withdrawal.approvalDenied: A withdrawal approval was explicitly denied before money movement processing.

Errors

See the error codes these endpoints return.

Sandbox simulations