Skip to main content
GET
/
payment_intents
/
{payment_intent_id}
Get a payment intent by ID
curl --request GET \
  --url https://api.sandbox.monite.com/v1/payment_intents/{payment_intent_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-monite-entity-id: <x-monite-entity-id>' \
  --header 'x-monite-version: <x-monite-version>'
{
  "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"
}

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"

Path Parameters

​
payment_intent_id
string<uuid>
required

ID of an existing payment intent that you want to retrieve.

Response

Successful Response

​
id
string<uuid>
required

A unique ID of this payment intent.

​
updated_at
string<date-time>
required

UTC date and time when this payment intent was last updated.

​
amount
integer
required

The payment amount in minor units.

Example:

125000

​
currency
string
required

The payment currency, as a three-letter ISO currency code.

Example:

"EUR"

​
payment_methods
enum<string>[]
required
Available options:
sepa_credit,
us_ach,
blik,
card,
bacs_direct_debit,
bancontact,
eps,
giropay,
ideal,
p24,
sepa_debit,
sofort,
applepay,
googlepay,
affirm,
klarna
Example:
["sepa_credit", "card"]
​
recipient
object
required

The payment recipient - either the current entity (in case of accounts receivable invoice payments) or a counterpart (in case of accounts payable bill payments).

​
status
string
required

The status of the payment intent.

​
application_fee_amount
integer
​
batch_payment_id
string<uuid>

Reserved for internal use.

​
invoice
object
​
object
object

If the payment link was created for a payable or receivable invoice stored in Monite (rather than an external invoice or a one-off payment), this object contains the ID of that payable or receivable.

​
payer
object
​
payment_link_id
string<uuid>

ID of the payment link associated with this payment intent. The payment link object contains the URL of the payment page.

​
payment_reference
string

The payment reference. If not provided explicitly by the client, Monite uses the invoice number (document_id) as the payment reference.

Note: Monite normalizes payment references for certain types of payments when passing information to the payment processing provider.

Example:

"PRJ/2025/0045"

​
provider
string

Reserved for internal use.

​
selected_payment_method
enum<string>

The payment method selected by the payer on the payment page, or null if the payment has not been initiated.

Available options:
sepa_credit,
us_ach,
blik,
card,
bacs_direct_debit,
bancontact,
eps,
giropay,
ideal,
p24,
sepa_debit,
sofort,
applepay,
googlepay,
affirm,
klarna