Sign in
Payment.Bulk Payment
BETA

Create bulk payment

Creates a bulk payment with given set of single payments. Single payments must be created first.

post/payment/v1/bulk-payments

Request body

idstring

The id of the bulk payment. Output only.

paymentRequestIdsstring[]

List of single payment ids. Bulk payment needs to have between 2 and 100 payment requests.

Example request

{
  "id": "b022334965b34c8bb50074e33f2f643b",
  "paymentRequestIds": [
    "4021be7088ee11ec8cc47b9807df655d",
    "4895bed088ee11ec9acc497070f7f574"
  ]
}

Response

A successful response.

idstring

The id of the bulk payment. Output only.

paymentRequestIdsstring[]

List of single payment ids. Bulk payment needs to have between 2 and 100 payment requests.

Example response

{
  "id": "b022334965b34c8bb50074e33f2f643b",
  "paymentRequestIds": [
    "4021be7088ee11ec8cc47b9807df655d",
    "4895bed088ee11ec9acc497070f7f574"
  ]
}

Changes

No recorded changes to this endpoint across all 9 revisions of this API.