Create a payment record

POST

/payment_records

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.

amountintegerRequired>=1

currencyenumRequired

objectobjectRequired

paid_atdatetimeRequired

payment_intent_idstringRequired

entity_user_idstringOptional

Response

Successful Response

idstring

amountinteger>=1

currencyenum

is_externalboolean

objectobject

paid_atdatetime

payment_intent_idstring

entity_user_idstringOptional

overpaid_amountintegerOptional>=0Defaults to 0

Filled in a case, if payment amount is more, than total_amount

Errors

POST

1 curl -X POST https://api.sandbox.monite.com/v1/payment_records \
2      -H "x-monite-version: 2023-09-01" \
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   "amount": 1,
8   "currency": "AED",
9   "object": {
10     "id": "id",
11     "type": "receivable"
12   },
13   "paid_at": "2024-01-15T09:30:00Z",
14   "payment_intent_id": "payment_intent_id"
15 }'

1 {
2   "id": "id",
3   "amount": 1,
4   "currency": "AED",
5   "is_external": true,
6   "object": {
7     "id": "id",
8     "new_status": "new_status",
9     "old_status": "old_status",
10     "type": "receivable"
11   },
12   "paid_at": "2024-01-15T09:30:00Z",
13   "payment_intent_id": "payment_intent_id",
14   "entity_user_id": "entity_user_id",
15   "overpaid_amount": 1
16 }

Get a payment record

Up Next

1	curl -X POST https://api.sandbox.monite.com/v1/payment_records \
2	-H "x-monite-version: 2023-09-01" \
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	"amount": 1,
8	"currency": "AED",
9	"object": {
10	"id": "id",
11	"type": "receivable"
12	},
13	"paid_at": "2024-01-15T09:30:00Z",
14	"payment_intent_id": "payment_intent_id"
15	}'