v1

latestOpenAPI 3.1.0Apache 2.02026-07-2498321298.8 KB

Direct Debits

List direct debit batch results

List processing results for individual direct debit requests that were part of a direct debit batch. The result items represent the result(s) of processing the batch request input but doesn't <b>not</b> represent the end-to-end processing of the payment.

get/payments/v2beta/direct-debit-batches/{id}/results

Path parameters

idstring required

Atlar resource ID.

Query parameters

tokenstring

If a query response contains a non-empty nextToken, use that value as token query parameter to continue pagination.

limitinteger

Limit the number of items in resulting query response.

errorsboolean

Filter based on presence of errors. If true, only results with at least one error will be included. If false, only results with no errors will be included.

skippedboolean

Filter based on skipped. If true, only results related to input record that were skipped will be included. If false, only results that are not related to skipped input records will be included.

Response

A list of payment batch results.

nextTokenstring required

Pagination token for next page. The value will be a non-empty string if there are more resources to be fetched. The value will be an empty string if there are no more resources to be fetched.

tokenstring required

The pagination token that was used for this request. The value will be an empty string if no token query parameter was provided with the request.

limitinteger required

The page limit that was used for this request.

Example response

{
  "items": [
    {
      "paymentId": "a0285f2e-f0c8-11ee-bae7-aa94e258a7ae",
      "recordIndex": 1
    }
  ],
  "nextToken": "eyIxIjogIlRoaXMgaXMgYSBkdW1teSBwYWdpbmF0aW9uIHRva2VuLiJ9",
  "token": "eyIwIjogIlRoaXMgaXMgYSBkdW1teSBwYWdpbmF0aW9uIHRva2VuLiJ9",
  "limit": 100
}