Bulk Payments

Get bulk payments by id

Get the status of all payments in an existing bulk payment of yours. This will allow you to find out which payments succeeded, are still pending or may have failed. This endpoint is paginated, so make sure to "flip through the pages" via the query parameter "page" if you need to get all the information.

getbulk-payments/{bulkPaymentId}/payments

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/payments/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

bulkPaymentIdstring

ID of the bulk payment to look into.

Query parameters

pagestring

Example:1

sortstring

Example:desc:amount,asc:internal_note

Headers

Acceptstring

Example:application/json

Authorizationstring

Example:Basic {your_token}

Response

countnumber

Number of individual payments found.

pagesnumber

Number of pages with all the individual payments.

currentPagenumber

Current page that the partner is exploring.

Example response

{
  "payments": [
    {
      "receiver_email": "master@airtm.io",
      "airtm_user_id": "e5b6d935-916d-49c6-8347-d9a98331e2c0",
      "amount": 10,
      "currency": "USD",
      "note": "salary",
      "internal_note": "system number 45113-231",
      "status": "PENDING",
      "hash": "6BD5RK4DC3VH835F"
    }
  ],
  "count": 2,
  "pages": 1,
  "currentPage": 1
}

Changes

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