Get mass payment status

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.

Path Params
string
required

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

Headers
string | null

API session ID generated with /v3/login

string | null

Developer key generated with your BILL developer account

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json