Bulk Payments

Get bulk payments details

Endpoint to retrieve the details of an existing bulk payment. The status RUNNING is the default after you have posted your bulk payment. It means that the individual payments are being processed and not all of them have processed yet. Once that has happened, the status will switch to DONE.

getbulk-payments/{bulkPaymentId}

Request

Base URL
https://payments.air-pay.io
Auth
HTTP basic
TypeScript
https://skmtc.dev/airtm/apis/airtm-enterprise-api-v1/docs/bulk-payments/:bulkPaymentId/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

bulkPaymentIdstring

Headers

Content-Typestring

Example:application/json

Authorizationstring

Example:Basic {your_token}

Response

idstring

statusstring

Status of the bulk payment, please check the Possible Statuses section in this endpoint's summary.

Example response

{
  "id": "2fa2b192-e140-4b69-b842-db4a4ef63063",
  "status": "DONE",
  "payments": {
    "count": 2,
    "pending": 1
  }
}

Changes

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