Skip to main content

TransferDetails

Represents the details of a transfer.

reasonTransferReason (string)required

The actual purpose of the transfer.

  • INITIAL_BALANCE_MIGRATION - after customer onboarding, migrations of existing balances
  • CRYPTO_BUY - the customer is buying crypto or other assets
  • CRYPTO_SELL - the customer is selling crypto or other assets
  • TRADING_PAIR - the transfer represents a trading pair transaction between customers with wallets
  • DEPOSIT - crediting the customer's wallet via non-Paysafe deposit options
  • WITHDRAWAL - debiting the customer's wallet via non-Paysafe withdrawal options
  • MERCHANT_FEE - charging a merchant fee
  • REFUND - refunding the customer on a previous transaction
  • CANCELATION - cancelation of a previous transaction
  • BONUS - customer is granted a bonus
  • CURRENCY_EXCHANGE - converting one currency to another
  • PURCHASE - the customer is purchasing goods or services from a merchant
  • PAYOUT - the merchant is compensating a customer for goods or services
  • PEER_TRANSFER - money transfer between customers with wallets
  • OTHER - any reason not explicitly mentioned in the transfers

Possible values: [INITIAL_BALANCE_MIGRATION, CRYPTO_BUY, CRYPTO_SELL, TRADING_PAIR, DEPOSIT, WITHDRAWAL, MERCHANT_FEE, REFUND, CANCELATION, BONUS, CURRENCY_EXCHANGE, PURCHASE, PAYOUT, PEER_TRANSFER, OTHER]

descriptionstring

Human readable description for the transfer.

Possible values: <= 200 characters

TransferDetails
{
  "reason": "INITIAL_BALANCE_MIGRATION",
  "description": "string"
}