Skip to main content
GET
/
payment_intents
Get payment intents
curl --request GET \
  --url https://api.sandbox.monite.com/v1/payment_intents \
  --header 'Authorization: Bearer <token>' \
  --header 'x-monite-entity-id: <x-monite-entity-id>' \
  --header 'x-monite-version: <x-monite-version>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "updated_at": "2023-11-07T05:31:56Z",
      "amount": 123,
      "currency": "<string>",
      "payment_methods": [
        "sepa_credit"
      ],
      "recipient": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "type": "entity",
        "bank_accounts": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "account_holder_name": "<string>",
            "account_number": "<string>",
            "bic": "<string>",
            "country": "DE",
            "currency": "EUR",
            "display_name": "<string>",
            "iban": "<string>",
            "is_default": false,
            "name": "<string>",
            "routing_number": "<string>",
            "sort_code": "<string>",
            "was_created_by_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        ],
        "name": "<string>"
      },
      "status": "<string>",
      "application_fee_amount": 123,
      "batch_payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "invoice": {
        "due_date": "2023-12-25",
        "file": {
          "mimetype": "<string>",
          "name": "<string>",
          "url": "<string>"
        },
        "issue_date": "2023-12-25"
      },
      "object": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "type": "payable"
      },
      "payer": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "type": "entity",
        "bank_accounts": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "account_holder_name": "<string>",
            "account_number": "<string>",
            "bic": "<string>",
            "country": "DE",
            "currency": "EUR",
            "display_name": "<string>",
            "iban": "<string>",
            "is_default": false,
            "name": "<string>",
            "routing_number": "<string>",
            "sort_code": "<string>",
            "was_created_by_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        ],
        "name": "<string>"
      },
      "payment_link_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "payment_reference": "<string>",
      "provider": "<string>",
      "selected_payment_method": "sepa_credit"
    }
  ],
  "next_pagination_token": "<string>",
  "prev_pagination_token": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
x-monite-version
string<date>
required
​
x-monite-entity-id
string<uuid>
required

The ID of the entity that owns the requested resource.

Example:

"9d2b4c8f-2087-4738-ba91-7359683c49a4"

Query Parameters

​
order
enum<string>
default:asc

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

Available options:
asc,
desc
​
limit
integer
default: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.

Required range: 1 <= x <= 100
​
pagination_token
string

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.

​
sort
enum<string>

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

Available options:
id,
created_at
​
object_id
string<uuid>

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

​
object_id__in
string<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

​
data
object[]
required

A list of payment intents.

​
next_pagination_token
string

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_token
string

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