BIbill
payments

Get mass payment status

Changed on

Get details about an existing mass payment batch.

In the response, you get the status of each payment in the mass payment batch. Each payment is either scheduled, completed, or failed. In addition, you get the count for the total number of payments in the mass payments batch.

Note: From the list of completed payments in the response, BILL begins processing payments based on the payment processDate.

get/v3/payments/mass/{paymentBatchId}

Request

  • Base URL
    https://gateway.stage.bill.com/connect
  • URL
    https://gateway.stage.bill.com/connect/v3/payments/mass/{paymentBatchId}
  • Auth
    none declared

Path parameters

paymentBatchIdstring required

BILL-generated ID of the mass payment batch. The value begins with bbq.

Example:{{mass_payment_batch_id}}

Headers

sessionIdstring nullable

API session ID generated with /v3/login

Example:{{session_id}}
devKeystring nullable

Developer key generated with your BILL developer account

Example:{{developer_key}}

Response

Get mass payment status response

countinteger

Total number of payments in the mass payment batch

Example response

{
  "count": 100
}

Changes