EQequalsmoney
Payment Batches

List payment batch payments

Retrieve paginated list of all payments for given payment batch.

get/payment-batches/{paymentBatchId}/payments

Request

Path parameters

paymentBatchIdstring uuid required

The unique ID of the Payment Batch.

Query parameters

accountIdstring required

The ID of the account to work with.

Example:F50091
sort'asc' | 'desc'

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

offsetinteger

The number of items to skip before returning results.

Example:100
limitinteger

The maximum number of results to return.

Example:200
searchstring
'created' | 'validated' | 'confirmed' | 'started' | 'completed' | 'failed'
OR
string[]
'alertErrors' | 'alertWarnings'
OR
string[]
string
OR
string[]
string
OR
string[]
'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'
OR
string[] 
[
  "USD"
]

Response

OK

limitinteger

The maximum number of results to return.

offsetinteger

The number of items to skip before returning results.

countinteger required

The total amount of records matching the querying when "limit" is ignored.

Example response

{
  "limit": 200,
  "offset": 100,
  "count": 67,
  "rows": [
    {
      "id": "string",
      "paymentBatchId": "1bce4e75-abe0-4ebf-b151-fbdb0b7d5ed9",
      "orderId": "string",
      "status": "created",
      "amount": "string",
      "fundingBudgetId": "6ee672f6-226f-4a72-8592-0f8dc5284ab1",
      "purposeCode": "string",
      "purpose": "string",
      "reference": "Invoice INV-12345 for Q1 consulting services",
      "currencyCode": "USD",
      "riskCheckedAt": "2019-08-24T14:15:22Z",
      "fees": "string",
      "charges": "SHA",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "inputIndex": 0,
      "externalId": "cust-ref-9f3b",
      "recipient": {
        "id": "string",
        "defaultReference": "string",
        "type": "individual",
        "name": "string",
        "displayName": "string",
        "subscribedEmails": [
          {
            "name": "string",
            "email": "user@example.com"
          }
        ],
        "accountIdentifier": "string",
        "bankIdentifier": "string",
        "secondaryBankIdentifier": "string",
        "intermediaryBankIdentifier": "string",
        "paymentNetwork": "SWIFT",
        "address": {
          "addressType": "ADDR",
          "streetName": "string",
          "buildingNumber": "string",
          "buildingName": "string",
          "postcode": "string",
          "city": "string",
          "region": "string",
          "countryCode": "GB"
        },
        "bankAddress": {
          "bankName": "string",
          "branch": "string",
          "buildingName": "string",
          "buildingNumber": "string",
          "streetName": "string",
          "city": "string",
          "region": "string",
          "postcode": "string",
          "countryCode": "GB"
        },
        "validation": {
          "nameMatch": true,
          "reason": "string",
          "reasonCode": "N000",
          "actualName": "string"
        }
      },
      "alerts": [
        {
          "inputIndex": 0,
          "timestamp": "2019-08-24T14:15:22Z",
          "type": "Error",
          "code": "string",
          "message": "string"
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.