List payment batch payments beta

Retrieve paginated list of all payments for given payment batch.

SecurityCommonAuth
Request
path Parameters
paymentBatchId
required
string <uuid> <= 36 characters

The unique ID of the Payment Batch.

query Parameters
accountId
required
string

The ID of the account to work with.

Example: accountId=F50091
sort
string
Default: "desc"

Determines whether the page of items are sorted in ascending or descending order.

Enum: "asc" "desc"
offset
integer
Default: 0

The number of items to skip before returning results.

Example: offset=100
limit
integer [ 1 .. 1000 ]
Default: 100

The maximum number of results to return.

Example: limit=200
search
string
string or Array of strings
Enum: "created" "validated" "confirmed" "started" "completed" "failed"
string or Array of strings
Enum: "alertErrors" "alertWarnings"
string or Array of strings
string or Array of strings
string or Array of strings
Enum: "AED" "AFN" "ALL" "AMD" "ANG" "AOA" "ARS" "AUD" "AWG" "AZN" "BAM" "BBD" "BDT" "BGN" "BHD" "BIF" "BMD" "BND" "BOB" "BOV" "BRL" "BSD" "BTN" "BWP" "BYN" "BZD" "CAD" "CDF" "CHF" "CLP" "CNY" "COP" "CRC" "CUC" "CUP" "CVE" "CZK" "DJF" "DKK" "DOP" "DZD" "EGP" "ERN" "ETB" "EUR" "FJD" "FKP" "GBP" "GEL" "GGP" "GHS" "GIP" "GMD" "GNF" "GTQ" "GYD" "HKD" "HNL" "HRK" "HTG" "HUF" "IDR" "ILS" "INR" "IQD" "IRR" "ISK" "JMD" "JOD" "JPY" "KES" "KGS" "KHR" "KMF" "KPW" "KRW" "KWD" "KYD" "KZT" "LAK" "LBP" "LKR" "LRD" "LSL" "LTL" "LVL" "LYD" "MAD" "MDL" "MGA" "MKD" "MMK" "MNT" "MOP" "MUR" "MVR" "MWK" "MXN" "MYR" "MZN" "NAD" "NGN" "NIO" "NOK" "NPR" "NZD" "OMR" "PAB" "PEN" "PGK" "PHP" "PKR" "PLN" "PYG" "QAR" "RON" "RSD" "RUB" "RWF" "SAR" "SBD" "SCR" "SEK" "SGD" "SHN" "SLL" "SOS" "SRD" "SSP" "STN" "SYP" "SZL" "THB" "TJS" "TMT" "TND" "TOP" "TRY" "TTD" "TWD" "TZS" "UAH" "UGX" "USD" "UYU" "UZS" "VND" "VUV" "WST" "XAF" "XAG" "XAU" "XCD" "XOF" "XPD" "XPF" "XPT" "YER" "ZAR" "ZMK" "ZMW" "ZWD"
Responses
200

OK

get/payment-batches/{paymentBatchId}/payments
Request samples 
Response samples 
application/json
{
  • "limit": 200,
  • "offset": 100,
  • "count": 67,
  • "rows": [
    ]
}