ADadfin
Payment requests

Bulk import payment requests

Changed on
post/payment_requests/bulk_import

Request

  • Base URL
    https://api.adfin.com/api
  • URL
    https://api.adfin.com/api/payment_requests/bulk_import
  • 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

Query parameters

collectionMethod'AUTO_COLLECT' | 'ON_DEMAND' | 'NONE' required

How the imported payment requests are expected to be collected. Currently, only NONE is supported.

Example:NONE
deleteMissingPaymentRequestsboolean required

Whether missing payment requests created in previous imports should be deleted.

Request body multipart/form-data

inputFilestring binary required

Input file to be processed during the bulk import.

Response

The bulk import request has been accepted for processing.

jobIdstring required

The internal id of the bulk import job

type'BULK_PAYMENT_REQUEST_IMPORT' required

The type of the import job

status'PENDING' | 'PROCESSING' | 'COMPLETED' | 'FAILED' | 'DELETED' required

The status of the import job

creationTimestring date-time required

The creation time of the import job

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