Create a batch payment

POST

/batch_payments

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.

Request

This endpoint expects an object.

payer_bank_account_idstringRequiredformat: "uuid"

payment_intentslist of objectsRequired

payment_method"us_ach"Required

Response

Successful Response

idstringformat: "uuid"

created_atdatetime

payer_bank_account_idstringformat: "uuid"

payment_intentslist of objects

payment_method"us_ach"

statusenum

Allowed values: createdprocessingpartially_successfulsucceededfailed

errormap from strings to anyOptional

total_amountintegerOptional

Errors

POST

1 curl -X POST https://api.sandbox.monite.com/v1/batch_payments \
2      -H "x-monite-version: 2024-05-25" \
3      -H "x-monite-entity-id: 9d2b4c8f-2087-4738-ba91-7359683c49a4" \
4      -H "Authorization: Bearer <token>" \
5      -H "Content-Type: application/json" \
6      -d '{
7   "payer_bank_account_id": "payer_bank_account_id",
8   "payment_intents": [
9     {
10       "object": {
11         "id": "id",
12         "type": "payable"
13       },
14       "recipient": {
15         "id": "id",
16         "type": "counterpart"
17       }
18     }
19   ],
20   "payment_method": "us_ach"
21 }'

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         "bank_account_id": "bank_account_id",
20         "payout_method": "bank_account"
21       },
22       "status": "status",
23       "error": {
24         "key": "value"
25       }
26     }
27   ],
28   "payment_method": "us_ach",
29   "status": "created",
30   "error": {
31     "key": "value"
32   },
33   "total_amount": 1
34 }

Get batch payment by ID

Up Next

1	curl -X POST https://api.sandbox.monite.com/v1/batch_payments \
2	-H "x-monite-version: 2024-05-25" \
3	-H "x-monite-entity-id: 9d2b4c8f-2087-4738-ba91-7359683c49a4" \
4	-H "Authorization: Bearer <token>" \
5	-H "Content-Type: application/json" \
6	-d '{
7	"payer_bank_account_id": "payer_bank_account_id",
8	"payment_intents": [
9	{
10	"object": {
11	"id": "id",
12	"type": "payable"
13	},
14	"recipient": {
15	"id": "id",
16	"type": "counterpart"
17	}
18	}
19	],
20	"payment_method": "us_ach"
21	}'

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	"bank_account_id": "bank_account_id",
20	"payout_method": "bank_account"
21	},
22	"status": "status",
23	"error": {
24	"key": "value"
25	}
26	}
27	],
28	"payment_method": "us_ach",
29	"status": "created",
30	"error": {
31	"key": "value"
32	},
33	"total_amount": 1
34	}