Get payment intents (v2023-09-01) — Monite Documentation

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>=1<=100

Max is 100

pagination_tokenstringOptional

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

sort"id" or "created_at"Optional

Allowed sort fields

Allowed values: idcreated_at

object_idstringOptional

ID of a payable or receivable invoice. If provided, returns only payment intents associated with the specified invoice.

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

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

1 { 2 "data": [ 3 { 4 "id": "id", 5 "updated_at": "2024-01-15T09:30:00Z", 6 "amount": 1, 7 "currency": "currency", 8 "payment_methods": [ 9 "sepa_credit" 10 ], 11 "recipient": { 12 "id": "id", 13 "type": "entity" 14 }, 15 "status": "status", 16 "application_fee_amount": 1, 17 "batch_payment_id": "batch_payment_id", 18 "object": { 19 "id": "id", 20 "type": "payable" 21 }, 22 "payer": { 23 "id": "id", 24 "type": "entity" 25 }, 26 "payment_link_id": "payment_link_id", 27 "payment_reference": "payment_reference", 28 "provider": "provider", 29 "selected_payment_method": "sepa_credit" 30 } 31 ], 32 "next_pagination_token": "next_pagination_token", 33 "prev_pagination_token": "prev_pagination_token" 34 }

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

1	{
2	"data": [
3	{
4	"id": "id",
5	"updated_at": "2024-01-15T09:30:00Z",
6	"amount": 1,
7	"currency": "currency",
8	"payment_methods": [
9	"sepa_credit"
10	],
11	"recipient": {
12	"id": "id",
13	"type": "entity"
14	},
15	"status": "status",
16	"application_fee_amount": 1,
17	"batch_payment_id": "batch_payment_id",
18	"object": {
19	"id": "id",
20	"type": "payable"
21	},
22	"payer": {
23	"id": "id",
24	"type": "entity"
25	},
26	"payment_link_id": "payment_link_id",
27	"payment_reference": "payment_reference",
28	"provider": "provider",
29	"selected_payment_method": "sepa_credit"
30	}
31	],
32	"next_pagination_token": "next_pagination_token",
33	"prev_pagination_token": "prev_pagination_token"
34	}