AIairtm
Bulk Payments

New bulk payment

Create a new bulk payment. You will receive a response with the id of your bulk payment and the processing will start asynchronously after you receive your response. You can check in with the progress of your ongoing bulk payment with any of the endpoints described further down this section.

postbulk-payments

Request

Headers

Content-Typestring
Example:application/json
Authorizationstring
Example:Basic {your_token}

Request body

0string[]

Single user information to receive the bulk payment.

Example request

{
  "0": [
    "patrick@airtm.io"
  ],
  "1": {
    "receiver_email": "master@airtm.io",
    "amount": 10,
    "currency": "USD",
    "note": "salary",
    "internal_note": "system number 45113-231"
  }
}

Response

OK

idstring uuid

Unique identifier automatically generated on bulk payment creation.

statusstring

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

Example response

{
  "id": "938ab3e6-a8f7-4995-bb23-a09703fc3289",
  "status": "RUNNING",
  "payments": {
    "count": 2
  }
}

Changes

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