Get batch payment by ID

GET

Path parameters

batch_payment_idstringRequired

Headers

Auth
AuthorizationstringRequired
Bearer authentication of the form Bearer <token>, where token is your auth token.
x-monite-versionstringRequired
x-monite-entity-idstringRequired

The ID of the entity that owns the requested resource.

Response

This endpoint returns an object.
idstring
created_atdatetime
payer_bank_account_idstring
payment_intentslist of objects
payment_method"us_ach"Defaults to us_ach
statusenum
Allowed values: createdprocessingpartially_successfulsucceededfailed
errormap from strings to anyOptional
total_amountintegerOptional

Errors