BatchTransferSummary

Summary of batch transfer statuses, fees, and amounts.

statuses object

Count of transfers per status. Keys are limited to PaymentStatus values. Zero values are not included in the object.

PREVIEWinteger

Count of transfers in PREVIEW status.

PENDINGinteger

Count of transfers in PENDING status.

PROCESSINGinteger

Count of transfers in PROCESSING status.

COMPLETEDinteger

Count of transfers in COMPLETED status.

FAILEDinteger

Count of transfers in FAILED status.

SCHEDULEDinteger

Count of transfers in SCHEDULED status.

ACCEPTEDinteger

Count of transfers in ACCEPTED status.

CANCELLEDinteger

Count of transfers in CANCELLED status.

REFUNDEDinteger

Count of transfers in REFUNDED status.

fees object[]

Aggregated fees for the batch.

Array [

amountinteger<int64>required

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

Possible values: >= 0

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.
• VAT_FEE - Consumer VAT fee (when applicable)
• 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, VAT_FEE, WITHDRAWAL_FEE]

Default value: OTHER_FEE

]

amounts object[]

Total debited amount in minor units per currency.

Array [

amountinteger<int64>

Total debited amount in minor units.

Example: 1000

currencyCurrency (string)

Currency alphabetic code as specified by ISO 4217

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

Example: EUR

]

BatchTransferSummary

{
  "statuses": {
    "PREVIEW": 2
  },
  "fees": [
    {
      "amount": 1000,
      "currency": "EUR",
      "paymentReason": "OTHER_FEE"
    }
  ],
  "amounts": [
    {
      "amount": 1000,
      "currency": "EUR"
    }
  ]
}