Get batch payment by ID

GET

/batch_payments/:batch_payment_id

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

Successful Response

idstring

created_atdatetime

payer_bank_account_idstring

payment_intentslist of objects

payment_method"us_ach"

statusenum

Allowed values: createdprocessingpartially_successfulsucceededfailed

errormap from strings to anyOptional

total_amountintegerOptional

Errors

GET

1 curl https://api.sandbox.monite.com/v1/batch_payments/batch_payment_id \
2      -H "x-monite-version: 2024-01-31" \
3      -H "x-monite-entity-id: x-monite-entity-id" \
4      -H "Authorization: Bearer <token>"

1 {
2   "id": "id",
3   "created_at": "2024-01-15T09:30:00Z",
4   "payer_bank_account_id": "payer_bank_account_id",
5   "payment_intents": [
6     {
7       "id": "id",
8       "created_at": "2024-01-15T09:30:00Z",
9       "amount": 1,
10       "currency": "AED",
11       "object": {
12         "id": "id",
13         "type": "payable"
14       },
15       "payment_reference": "payment_reference",
16       "recipient": {
17         "id": "id",
18         "type": "counterpart"
19       },
20       "status": "status",
21       "error": {
22         "key": "value"
23       }
24     }
25   ],
26   "payment_method": "us_ach",
27   "status": "created",
28   "error": {
29     "key": "value"
30   },
31   "total_amount": 1
32 }

Complete entity bank account verification

Up Next

1	curl https://api.sandbox.monite.com/v1/batch_payments/batch_payment_id \
2	-H "x-monite-version: 2024-01-31" \
3	-H "x-monite-entity-id: x-monite-entity-id" \
4	-H "Authorization: Bearer <token>"

1	{
2	"id": "id",
3	"created_at": "2024-01-15T09:30:00Z",
4	"payer_bank_account_id": "payer_bank_account_id",
5	"payment_intents": [
6	{
7	"id": "id",
8	"created_at": "2024-01-15T09:30:00Z",
9	"amount": 1,
10	"currency": "AED",
11	"object": {
12	"id": "id",
13	"type": "payable"
14	},
15	"payment_reference": "payment_reference",
16	"recipient": {
17	"id": "id",
18	"type": "counterpart"
19	},
20	"status": "status",
21	"error": {
22	"key": "value"
23	}
24	}
25	],
26	"payment_method": "us_ach",
27	"status": "created",
28	"error": {
29	"key": "value"
30	},
31	"total_amount": 1
32	}