ADadfin
Payment requests

Retrieve bulk payment request import job items

Changed on
get/payment_requests/bulk_import/{jobId}/items

Request

  • Base URL
    https://api.adfin.com/api
  • URL
    https://api.adfin.com/api/payment_requests/bulk_import/{jobId}/items
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://api.staging.adfin.com/api/oauth2/token
    • or OAuth 2
      Client credentials
      Token URL: https://api.adfin.com/api/oauth2/token

Path parameters

jobIdstring uuid required

The ID of the bulk payment request import job

Query parameters

statusesstring[]

The status of the bulk payment request import job item

  • PENDING: The item is still to be processed.
  • PROCESSING: The item is currently processing.
  • COMPLETED: The item has been processed.
  • FAILED: The item has failed to be processed.
pageinteger

Zero-based page index (0..N)

sizeinteger

The size of the page to be returned

sortstring[]

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Response

Paginated response for the list of bulk payment request import job items

Changes

  • f651a1d29eedRevision changes
    • info

      the endpoint scheme security Biller Access Token (Production) was added to the API

    • info

      the endpoint scheme security Biller Access Token (Staging) was added to the API