Get payment records

GET

/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.

Query parameters

order"asc" or "desc"Optional

Order by

Allowed values: ascdesc

limitintegerOptional

Max is 100

pagination_tokenstringOptional

A token, obtained from previous page. Prior over other filters

sortenumOptional

Allowed sort fields

Allowed values: paid_atamountoverpaid_amount

is_externalbooleanOptional

object_idstringOptional

Response

Successful Response

datalist of objects

next_pagination_tokenstringOptional

A token that can be sent in the pagination_token query parameter to get the next page of results, or null if there is no next page (i.e. you’ve reached the last page).

prev_pagination_tokenstringOptional

A token that can be sent in the pagination_token query parameter to get the previous page of results, or null if there is no previous page (i.e. you’ve reached the first page).

Errors

Create a payment record

Up Next

1	curl https://api.sandbox.monite.com/v1/payment_records \
2	-H "x-monite-version: 2024-01-31" \
3	-H "x-monite-entity-id: 9d2b4c8f-2087-4738-ba91-7359683c49a4" \
4	-H "Authorization: Bearer <token>"

1	{
2	"data": [
3	{
4	"id": "id",
5	"amount": 1,
6	"currency": "AED",
7	"is_external": true,
8	"object": {
9	"id": "id",
10	"new_status": "new_status",
11	"old_status": "old_status",
12	"type": "receivable"
13	},
14	"paid_at": "2024-01-15T09:30:00Z",
15	"payment_intent_id": "payment_intent_id",
16	"entity_user_id": "entity_user_id",
17	"overpaid_amount": 1
18	}
19	],
20	"next_pagination_token": "next_pagination_token",
21	"prev_pagination_token": "prev_pagination_token"
22	}