Skip to main content

CustomerTransferRequest

Describes a transfer request to another customer or local currency exchange.

amountint64required

Transaction amount in minor units.

Example: 1000
currencyCodeCurrency (string)required

Currency alphabetic code as specified by ISO 4217

Possible values: >= 3 characters and <= 3 characters

Example: EUR
recipient object

Contains transfer recipient information. If used in CustomerTransferRequest context, the system tries to resolve email to customerId in the system.

customerIdstring
emailemail

Possible values: <= 150 characters

merchantRefNumstring

Merchant reference number associated with the transaction.

Possible values: <= 50 characters

Example: 5040452805
fxQuotestring

(In Development) FX Quote ID for the transfer in case currency conversion is required. If not passed currency conversion is not perfomed.

transferDetails objectrequired

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

CustomerTransferRequest
{
"amount": 1000,
"currencyCode": "EUR",
"recipient": {
"customerId": "string",
"email": "user@example.com"
},
"merchantRefNum": "5040452805",
"fxQuote": "string",
"transferDetails": {
"reason": "INITIAL_BALANCE_MIGRATION",
"description": "string"
}
}