Get payment intents

GET

/payment_intents

GET

/v1/payment_intents

$ curl https://api.sandbox.monite.com/v1/payment_intents \
>      -H "x-monite-version: 2024-05-25" \
>      -H "x-monite-entity-id: 9d2b4c8f-2087-4738-ba91-7359683c49a4" \
>      -H "Authorization: Bearer <token>"

1 {
2   "data": [
3     {
4       "id": "id",
5       "updated_at": "2024-01-15T09:30:00Z",
6       "amount": 125000,
7       "currency": "EUR",
8       "payment_methods": [
9         "sepa_credit",
10         "card"
11       ],
12       "recipient": {
13         "id": "id",
14         "type": "entity",
15         "bank_accounts": [
16           {
17             "id": "id",
18             "account_holder_name": "Bob Jones",
19             "account_number": "12345678",
20             "bic": "DEUTDEFFXXX",
21             "country": "AF",
22             "currency": "AED",
23             "display_name": "Primary account",
24             "iban": "DE74500700100100000900",
25             "is_default": true,
26             "name": "Primary account",
27             "routing_number": "routing_number",
28             "sort_code": "123456",
29             "was_created_by_user_id": "was_created_by_user_id"
30           }
31         ],
32         "name": "name"
33       },
34       "status": "status",
35       "application_fee_amount": 1,
36       "batch_payment_id": "batch_payment_id",
37       "invoice": {
38         "due_date": "due_date",
39         "file": {
40           "mimetype": "application/pdf",
41           "name": "INV-00042.pdf",
42           "url": "https://example.com/path/to/invoice.pdf"
43         },
44         "issue_date": "issue_date"
45       },
46       "object": {
47         "id": "id",
48         "type": "payable"
49       },
50       "payer": {
51         "id": "id",
52         "type": "entity",
53         "bank_accounts": [
54           {
55             "id": "id",
56             "account_holder_name": "Bob Jones",
57             "account_number": "12345678",
58             "bic": "DEUTDEFFXXX",
59             "country": "AF",
60             "currency": "AED",
61             "display_name": "Primary account",
62             "iban": "DE74500700100100000900",
63             "is_default": true,
64             "name": "Primary account",
65             "routing_number": "routing_number",
66             "sort_code": "123456",
67             "was_created_by_user_id": "was_created_by_user_id"
68           }
69         ],
70         "name": "name"
71       },
72       "payment_link_id": "payment_link_id",
73       "payment_reference": "PRJ/2025/0045",
74       "provider": "provider",
75       "selected_payment_method": "sepa_credit"
76     }
77   ],
78   "next_pagination_token": "next_pagination_token",
79   "prev_pagination_token": "prev_pagination_token"
80 }

Returns a list of all payment intents. Monite creates payment intents automatically for each payment link. Payment intents let you track the status of payments made via payment links.

To find a payment intent for a specific payable or receivable invoice, provide the object_id parameter. Alternatively, you can use the object_id__in parameter to find payment intents for all invoices from the list.

If no payment intents matching the search criteria were found, the response contains an empty data array.

Returns a list of all [payment intents](https://docs.monite.com/payments/payment-intents). Monite creates payment intents automatically for each [payment link](https://docs.monite.com/payments/payment-links). Payment intents let you track the status of payments made via payment links. To find a payment intent for a specific payable or receivable invoice, provide the `object_id` parameter. Alternatively, you can use the `object_id__in` parameter to find payment intents for all invoices from the list. If no payment intents matching the search criteria were found, the response contains an empty `data` array.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

orderenumOptional

Sort order (ascending by default). Typically used together with the sort parameter.

Allowed values:

limitintegerOptional1-100Defaults to 100

The number of items (0 .. 100) to return in a single page of the response. The response may contain fewer items if it is the last or only page.

pagination_tokenstringOptional

A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If pagination_token is specified, all other query parameters are ignored and inferred from the initial query.

If not specified, the first page of results will be returned.

A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters are ignored and inferred from the initial query. If not specified, the first page of results will be returned.

sortenumOptional

The field to sort the results by. Typically used together with the order parameter.

Allowed values:

object_idstringOptionalformat: "uuid"

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

object_id__instringOptionalformat: "uuid"

A list of payable IDs and/or receivable IDs. If provided, returns only payment intents associated with the specified payable and receivable invoices. Valid but nonexistent IDs do not raise errors but produce no results.

Response

Successful Response

datalist of objects

A list of payment intents.

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

400

Get Payment Intents Request Bad Request Error

401

Get Payment Intents Request Unauthorized Error

422

Get Payment Intents Request Unprocessable Entity Error

429

Get Payment Intents Request Too Many Requests Error

Authentication

Headers

Query parameters

Response

Errors