Skip to main content

TransferRequest

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

    amount int64required

    Transaction amount in minor units.

    currencyCode Currency (string)required

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

    Currency alphabetic code as specified by ISO 4217

    recipient

    object

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

    customerId string
    email email

    Possible values: <= 150 characters

    merchantRefNum string

    Possible values: <= 50 characters

    Merchant reference number associated with the transaction.

    fxQuote string

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

    transferDetails

    object

    required

    Represents the details of a transfer.

    reason TransferReason (string)required

    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]

    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
    description string

    Possible values: <= 200 characters

    Human readable description for the transfer.

    fees

    object[]

    Customer fees attached to the transaction.

  • Array [

    • amount int64required

    Default value: 0

    Amount of the merchant payment, in mintor units. If currency is not specified, then the main transaction currency is used.

    currency Currency (string)

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

    Currency alphabetic code as specified by ISO 4217

    paymentReason FeePaymentReason (string)required

    Possible values: [MERCHANT_FEE, ATM_FEE, FX_FEE, PAYSAFE_FEE, OTHER_FEE, SENDER_FEE, RECIPIENT_FEE, DEPOSIT_FEE, WITHDRAWAL_FEE]

    Default value: OTHER_FEE

    Fee payment reason.

    • SENDER_FEE - Fee that will be applied to sender party of transfer collected into partner merchant wallet.
    • RECIPIENT_FEE - Fee that will be applied to recipient client of transfer collected into partner merchant wallet.
    • DEPOSIT_FEE - Fee charged for deposit transactions collected into partner merchant wallet.
    • WITHDRAWAL_FEE - Fee charged for withdrawal transactions collected into partner merchant wallet.
    • MERCHANT_FEE - Fee for the payment service collected into partner merchant wallet.
    • PAYSAFE_FEE - Fee collected by Paysafe for the provided payment service. Usually Paysafe Fee is not directly applied to customer transactions.
    • ATM_FEE - Fee for ATM service, when using prepaid cards.
    • FX_FEE - Fee applied, when payment requires currency exchange.
    • OTHER_FEE - It could be used for any additional, unspecified fees that may be applied to a transaction
    merchantId string

    The target merchant wallet id.

    recipientCurrency Currency (string)

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

    Currency alphabetic code as specified by ISO 4217

    merchantAccountId string

    The target account in which the payment is accepted. If not specified the account is determined by the main transaction currency.

  • ]