TransferRequest

Describes a transfer request. The following types of transfers are supported:

• Customer to Merchant - Where the sender is a regular customer and recipient is the merchant
• Merchant to Customer - Where the sender is the merchant and the recipient is the customer
• Customer to Customer - also called Peer to Peer transfer.

Note! Transfer reason and reasonDescription are deprecated and should be specified using the transferDetails object. If both specified the transferDetails have higher precedence.

amountint64required

Transaction amount in minor units.

Example: 1000

feeint64

Transaction fee in minor units.

Example: 100

currencyCodeCurrency (string)required

Currency alphabetic code as specified by ISO 4217

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

Example: EUR

sender objectrequired

Account specific view of the slip.

accountIdstring

Account identifier.

Example: 5014567344

customerIdstring

Customer id of the account owner.

Example: 5435323362

slipIdstring

Slip identifier.

Example: 5009964049

transactions object[]

List of transactions associated with this account, that belong to the s.

Array [

idstringrequired

Transaction id

Example: 544232

slipIdstringrequired

Transaction slip Id.

Example: 5009964049

customerIdstringrequired

Wallet customer id.

Example: 5435323362

accountIdstringrequired

Account Id associated with this transaction.

Example: 212345

typeTransactionType (string)

Represents the type of the transaction.

Possible values: [DEPOSIT, WITHDRAWAL, PAYOUT, CHARGEBACK_REVERSAL, RETURNED_WITHDRAWAL, CHARGEBACK, MERCHANT_FEE, TRANSACTION_FEE, DAILY_TRANSACTIONS_FEE, TRANSFER_IN, TRANSFER_OUT, TRANSFER_RETURN, REFUND, CURRENCY_EXCHANGE, PAYSAFE_FEE, PREPAID_CARD, PREPAID_CARD_AUTHORIZATION, APPLICATION_FEE, SET_UP_FEE, MONTHLY_MAINTENANCE_FEE]

Example: DEPOSIT

amountint64

Transaction amount in minor units.

Example: 1000

currencyCodeCurrency (string)

Currency alphabetic code as specified by ISO 4217

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

Example: EUR

feeint64deprecated

Transaction fee in minor units. Deprecated in favor of fees field.

Example: 100

fees object[]

Customer fees attached to the transaction.

Array [

amountint64required

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

Default value: 0

Example: 1000

currencyCurrency (string)

Currency alphabetic code as specified by ISO 4217

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

Example: EUR

paymentReasonFeePaymentReason (string)required

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

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

Default value: OTHER_FEE

]

creationTimedate-time

Represents RFC 3339, section 5.6 date-time.

Example: 2021-07-15T17:54:12Z

lastChangeDatedate-time

Represents RFC 3339, section 5.6 date-time.

Example: 2021-07-15T17:54:12Z

directionstringrequired

Transaction direction.

Possible values: [CREDIT, DEBIT]

instrumentIdstringdeprecated

ID of the payment instrument. Deprecated in favour of instrumentDetails.instrumentId field.

instrumentTypeInstrumentType (string)deprecated

Type of the instrument. Deprecated in favour of instrumentDetails.instrumentType field.

Possible values: [SEPA_BANK_ACCOUNT, UK_BANK_ACCOUNT, US_BANK_ACCOUNT, CCI_BANK_ACCOUNT, CARD]

Example: CARD

paymentTypePaymentType (string)

Type of instrument. Used as discriminator for different Payment types.

• CARD
• BANK_TRANSFER
• RAPID_TRANSFER
• TRANSFER

Possible values: [CARD, BANK_TRANSFER, RAPID_TRANSFER, TRANSFER]

statusTransactionStatus (string)required

Represents the status of a transaction.

• PENDING - Transaction is created and further action is required by the customer.
• PROCESSING - Transaction is scheduled for processing by the payment provider.
• COMPLETED - Transaction is completed. Note that some transactions might be completed from Embedded Wallet point of view, but not from customer point of view, since money movement might take some time outside of the Embedded Wallet network.
• FAILED - Transaction is failed. Check STATUS_REASON property for details.
• CANCELLED - Transaction have been cancelled
• REFUNDED - Valid only for deposit transactions.
• DECLINED - transaction is declined.

Possible values: [PENDING, PROCESSING, COMPLETED, FAILED, CANCELLED, REFUNDED, DECLINED]

Example: COMPLETED

statusReasonstring

Status reason for FAILED transactions. See TransactionStatusReason for available values.

Possible values: <= 60 characters

merchantRefNumExternalId (string)

Customer identifier used in Partner system.

Possible values: non-empty and <= 40 characters

Example: af5c8b52-0afd-4799-85ab-fe659a076932

balanceint64

Balance of the account after the transaction in minor currency units.

recipientReferencestring

Additional reference information for the recipient passed by the sender of the transaction. This information is not valid or present for all transaction types.

fxAmount object

(In Development)

Contains the amount in converted currency during currency conversion.

amountinteger

Converted amount (in minor units).

ratenumber

Currency conversion rate.

currencyCurrency (string)

Currency alphabetic code as specified by ISO 4217

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

Example: EUR

transferDetails object

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

cardPaymentDetails objectdeprecated

Details about a payment with customer's card.

This class is deprecated because it is now part of 'PaymentInstrumentTransactionDetails' with new name 'PrepaidCardInstrumentTransactionDetails'.

cardIdstring

Prepaid card ID.

mobileWalletTypestring

Mobile wallet type.

Possible values: [GOOGLE_PAY, APPLE_PAY, SAMSUNG_PAY]

obfuscatedCardNumberstring

Obfuscated card number.

Example: *1234

merchantDetails object

namestring

Merchant name.

Example: Starbucks

location object

citystring

Merchant location city.

statestring

Merchant location state.

zipstring

Merchant location zip.

mcc object

idstring

Merchant category id.

namestring

Merchant category name.

paymentAmountint64

Amount paid with customer's card, in minor units.

Example: 1200

paymentAmountCurrencyCodeCurrency (string)

Currency alphabetic code as specified by ISO 4217

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

Example: EUR

peerDetails object

Represents the details of a peer.

firstNamestring

Peer first name.

Example: John

lastNamestring

Peer last name.

Example: Doe

instrumentDetails object

Represents details about a customer's payment instrument.

instrumentIdstring

Instrument ID.

Example: 123456789

instrumentTypestring

Represents the type of an instrument.

| Value | Description| |---|---| | CARD | Card | | PREPAID_CARD | Prepaid Card | | SEPA_BANK_ACCOUNT| SEPA Bank account | | US_BANK_ACCOUNT | US Bank account | | UK_BANK_ACCOUNT | UK Bank account | | CCI_BANK_ACCOUNT | CCI Bank account |

Possible values: [CARD, PREPAID_CARD, SEPA_BANK_ACCOUNT, US_BANK_ACCOUNT, UK_BANK_ACCOUNT, CCI_BANK_ACCOUNT]

]

recipient objectrequired

Account specific view of the slip.

accountIdstring

Account identifier.

Example: 5014567344

customerIdstring

Customer id of the account owner.

Example: 5435323362

slipIdstring

Slip identifier.

Example: 5009964049

transactions object[]

List of transactions associated with this account, that belong to the s.

Array [

idstringrequired

Transaction id

Example: 544232

slipIdstringrequired

Transaction slip Id.

Example: 5009964049

customerIdstringrequired

Wallet customer id.

Example: 5435323362

accountIdstringrequired

Account Id associated with this transaction.

Example: 212345

typeTransactionType (string)

Represents the type of the transaction.

Possible values: [DEPOSIT, WITHDRAWAL, PAYOUT, CHARGEBACK_REVERSAL, RETURNED_WITHDRAWAL, CHARGEBACK, MERCHANT_FEE, TRANSACTION_FEE, DAILY_TRANSACTIONS_FEE, TRANSFER_IN, TRANSFER_OUT, TRANSFER_RETURN, REFUND, CURRENCY_EXCHANGE, PAYSAFE_FEE, PREPAID_CARD, PREPAID_CARD_AUTHORIZATION, APPLICATION_FEE, SET_UP_FEE, MONTHLY_MAINTENANCE_FEE]

Example: DEPOSIT

amountint64

Transaction amount in minor units.

Example: 1000

currencyCodeCurrency (string)

Currency alphabetic code as specified by ISO 4217

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

Example: EUR

feeint64deprecated

Transaction fee in minor units. Deprecated in favor of fees field.

Example: 100

fees object[]

Customer fees attached to the transaction.

Array [

amountint64required

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

Default value: 0

Example: 1000

currencyCurrency (string)

Currency alphabetic code as specified by ISO 4217

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

Example: EUR

paymentReasonFeePaymentReason (string)required

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

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

Default value: OTHER_FEE

]

creationTimedate-time

Represents RFC 3339, section 5.6 date-time.

Example: 2021-07-15T17:54:12Z

lastChangeDatedate-time

Represents RFC 3339, section 5.6 date-time.

Example: 2021-07-15T17:54:12Z

directionstringrequired

Transaction direction.

Possible values: [CREDIT, DEBIT]

instrumentIdstringdeprecated

ID of the payment instrument. Deprecated in favour of instrumentDetails.instrumentId field.

instrumentTypeInstrumentType (string)deprecated

Type of the instrument. Deprecated in favour of instrumentDetails.instrumentType field.

Possible values: [SEPA_BANK_ACCOUNT, UK_BANK_ACCOUNT, US_BANK_ACCOUNT, CCI_BANK_ACCOUNT, CARD]

Example: CARD

paymentTypePaymentType (string)

Type of instrument. Used as discriminator for different Payment types.

• CARD
• BANK_TRANSFER
• RAPID_TRANSFER
• TRANSFER

Possible values: [CARD, BANK_TRANSFER, RAPID_TRANSFER, TRANSFER]

statusTransactionStatus (string)required

Represents the status of a transaction.

• PENDING - Transaction is created and further action is required by the customer.
• PROCESSING - Transaction is scheduled for processing by the payment provider.
• COMPLETED - Transaction is completed. Note that some transactions might be completed from Embedded Wallet point of view, but not from customer point of view, since money movement might take some time outside of the Embedded Wallet network.
• FAILED - Transaction is failed. Check STATUS_REASON property for details.
• CANCELLED - Transaction have been cancelled
• REFUNDED - Valid only for deposit transactions.
• DECLINED - transaction is declined.

Possible values: [PENDING, PROCESSING, COMPLETED, FAILED, CANCELLED, REFUNDED, DECLINED]

Example: COMPLETED

statusReasonstring

Status reason for FAILED transactions. See TransactionStatusReason for available values.

Possible values: <= 60 characters

merchantRefNumExternalId (string)

Customer identifier used in Partner system.

Possible values: non-empty and <= 40 characters

Example: af5c8b52-0afd-4799-85ab-fe659a076932

balanceint64

Balance of the account after the transaction in minor currency units.

recipientReferencestring

Additional reference information for the recipient passed by the sender of the transaction. This information is not valid or present for all transaction types.

fxAmount object

(In Development)

Contains the amount in converted currency during currency conversion.

amountinteger

Converted amount (in minor units).

ratenumber

Currency conversion rate.

currencyCurrency (string)

Currency alphabetic code as specified by ISO 4217

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

Example: EUR

transferDetails object

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

cardPaymentDetails objectdeprecated

Details about a payment with customer's card.

This class is deprecated because it is now part of 'PaymentInstrumentTransactionDetails' with new name 'PrepaidCardInstrumentTransactionDetails'.

cardIdstring

Prepaid card ID.

mobileWalletTypestring

Mobile wallet type.

Possible values: [GOOGLE_PAY, APPLE_PAY, SAMSUNG_PAY]

obfuscatedCardNumberstring

Obfuscated card number.

Example: *1234

merchantDetails object

namestring

Merchant name.

Example: Starbucks

location object

citystring

Merchant location city.

statestring

Merchant location state.

zipstring

Merchant location zip.

mcc object

idstring

Merchant category id.

namestring

Merchant category name.

paymentAmountint64

Amount paid with customer's card, in minor units.

Example: 1200

paymentAmountCurrencyCodeCurrency (string)

Currency alphabetic code as specified by ISO 4217

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

Example: EUR

peerDetails object

Represents the details of a peer.

firstNamestring

Peer first name.

Example: John

lastNamestring

Peer last name.

Example: Doe

instrumentDetails object

Represents details about a customer's payment instrument.

instrumentIdstring

Instrument ID.

Example: 123456789

instrumentTypestring

Represents the type of an instrument.

| Value | Description| |---|---| | CARD | Card | | PREPAID_CARD | Prepaid Card | | SEPA_BANK_ACCOUNT| SEPA Bank account | | US_BANK_ACCOUNT | US Bank account | | UK_BANK_ACCOUNT | UK Bank account | | CCI_BANK_ACCOUNT | CCI Bank account |

Possible values: [CARD, PREPAID_CARD, SEPA_BANK_ACCOUNT, US_BANK_ACCOUNT, UK_BANK_ACCOUNT, CCI_BANK_ACCOUNT]

]

merchantRefNumstringrequired

Merchant reference number associated witht the transaction.

Possible values: <= 50 characters

Example: 5040452805

reasonTransferReason (string)

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]

reasonDescriptionstringdeprecated

Possible values: <= 200 characters

fxQuotestring

(In Development) FX Quote ID for the transfer in case currency conversion is required. If not passed and currency conversion is required the rate would be automatically assigned.

transferDetails object

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

TransferRequest

{
  "amount": 1000,
  "fee": 100,
  "currencyCode": "EUR",
  "sender": {
    "accountId": "5014567344",
    "customerId": "5435323362",
    "slipId": "5009964049",
    "transactions": [
      {
        "id": "544232",
        "slipId": "5009964049",
        "customerId": "5435323362",
        "accountId": "212345",
        "type": "DEPOSIT",
        "amount": 1000,
        "currencyCode": "EUR",
        "fees": [
          {
            "amount": 1000,
            "currency": "EUR",
            "paymentReason": "OTHER_FEE"
          }
        ],
        "creationTime": "2021-07-15T17:54:12Z",
        "lastChangeDate": "2021-07-15T17:54:12Z",
        "direction": "CREDIT",
        "instrumentType": "CARD",
        "paymentType": "CARD",
        "status": "COMPLETED",
        "statusReason": "string",
        "merchantRefNum": "af5c8b52-0afd-4799-85ab-fe659a076932",
        "balance": 0,
        "recipientReference": "string",
        "fxAmount": {
          "amount": 0,
          "rate": 0,
          "currency": "EUR"
        },
        "transferDetails": {
          "reason": "INITIAL_BALANCE_MIGRATION",
          "description": "string"
        },
        "peerDetails": {
          "firstName": "John",
          "lastName": "Doe"
        },
        "instrumentDetails": {
          "instrumentId": "123456789",
          "instrumentType": "CARD"
        }
      }
    ]
  },
  "recipient": {
    "accountId": "5014567344",
    "customerId": "5435323362",
    "slipId": "5009964049",
    "transactions": [
      {
        "id": "544232",
        "slipId": "5009964049",
        "customerId": "5435323362",
        "accountId": "212345",
        "type": "DEPOSIT",
        "amount": 1000,
        "currencyCode": "EUR",
        "fees": [
          {
            "amount": 1000,
            "currency": "EUR",
            "paymentReason": "OTHER_FEE"
          }
        ],
        "creationTime": "2021-07-15T17:54:12Z",
        "lastChangeDate": "2021-07-15T17:54:12Z",
        "direction": "CREDIT",
        "instrumentType": "CARD",
        "paymentType": "CARD",
        "status": "COMPLETED",
        "statusReason": "string",
        "merchantRefNum": "af5c8b52-0afd-4799-85ab-fe659a076932",
        "balance": 0,
        "recipientReference": "string",
        "fxAmount": {
          "amount": 0,
          "rate": 0,
          "currency": "EUR"
        },
        "transferDetails": {
          "reason": "INITIAL_BALANCE_MIGRATION",
          "description": "string"
        },
        "peerDetails": {
          "firstName": "John",
          "lastName": "Doe"
        },
        "instrumentDetails": {
          "instrumentId": "123456789",
          "instrumentType": "CARD"
        }
      }
    ]
  },
  "merchantRefNum": "5040452805",
  "reason": "INITIAL_BALANCE_MIGRATION",
  "fxQuote": "string",
  "transferDetails": {
    "reason": "INITIAL_BALANCE_MIGRATION",
    "description": "string"
  }
}