Skip to main content

BatchTransferSummary

Summary of batch transfer statuses 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.

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
    },
    "amounts": [
    {
    "amount": 1000,
    "currency": "EUR"
    }
    ]
    }