AIairtm
Bulk Payments

Get bulk payments history

Endpoint to get all bulk payments associated with your account. This will give you an overview of all the bulk payments you ever posted. 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

Request

Query parameters

pagestring

Page number to get bulk payments information from.

Example:1

Headers

Acceptstring
Example:application/json
Authorizationstring
Example:Basic {your_token}

Response

OK

countnumber

Number of bulk payments found.

pagesnumber

Number of pages with bulk payment information.

currentPagenumber

Current page that the partner is exploring.

Example response

{
  "bulk_payments": [
    {
      "id": "47b08782-20c1-4c8e-b7a5-1ca0b046af08",
      "status": "DONE",
      "created_at": "2021-06-25T14:31:24.549Z",
      "payments": {
        "count": 4,
        "completed": 4
      }
    }
  ],
  "count": 5,
  "pages": 1,
  "currentPage": 1
}

Changes

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