POST
/
payments_batches
/
{id}
/
pay
Pay / Start payments batch
curl --request POST \
  --url https://v2.firstpromoter.com/api/v2/company/payments_batches/{id}/pay \
  --header 'Account-ID: <account-id>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "otp": "<string>",
  "otp_code": "<string>"
}'
{
  "id": 123,
  "status": "<string>",
  "ext_reference": "<string>",
  "ext_id": "<string>",
  "scheduled_at": "2023-11-07T05:31:56Z",
  "processing_started_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "is_payable": true,
  "is_retriable": true,
  "is_payment_otp_required": true,
  "total": 123,
  "promoters_count": 123,
  "error": "<string>"
}

Authorizations

​
Authorization
string
header
required

Access token passed as a Bearer token in the Authorization header

Headers

​
Account-ID
string
required

Account identifier that specifies which account is making the request

Example:

"acc_123456"

Path Parameters

​
id
integer
required

Payment batch ID

Body

application/json

Response

200
application/json

Successful operation

The response is of type object.