Get payment intent by ID

GET

/payment_intents/:payment_intent_id

Path parameters

payment_intent_idstringRequired

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.

Response

Successful Response

idstring

updated_atdatetime

amountinteger

currencystring

payment_methodslist of enums

recipientobject

statusstring

application_fee_amountintegerOptional

batch_payment_idstringOptional

invoiceobjectOptional

objectobjectOptional

payerobjectOptional

payment_link_idstringOptional

payment_referencestringOptional

providerstringOptional

selected_payment_methodenumOptional

Errors

GET

1 curl https://api.sandbox.monite.com/v1/payment_intents/payment_intent_id \
2      -H "x-monite-version: 2024-01-31" \
3      -H "x-monite-entity-id: x-monite-entity-id" \
4      -H "Authorization: Bearer <token>"

1 {
2   "id": "id",
3   "updated_at": "2024-01-15T09:30:00Z",
4   "amount": 1,
5   "currency": "currency",
6   "payment_methods": [
7     "sepa_credit"
8   ],
9   "recipient": {
10     "id": "id",
11     "type": "entity",
12     "bank_accounts": [
13       {
14         "id": "id",
15         "account_holder_name": "Bob Jones",
16         "account_number": "12345678",
17         "bic": "DEUTDEFFXXX",
18         "display_name": "Primary account",
19         "iban": "DE74500700100100000900",
20         "name": "Primary account",
21         "sort_code": "123456"
22       }
23     ],
24     "name": "name"
25   },
26   "status": "status",
27   "application_fee_amount": 1,
28   "batch_payment_id": "batch_payment_id",
29   "invoice": {
30     "due_date": "due_date",
31     "file": {
32       "mimetype": "mimetype",
33       "name": "name",
34       "url": "url"
35     },
36     "issue_date": "issue_date"
37   },
38   "object": {
39     "id": "id",
40     "type": "payable"
41   },
42   "payer": {
43     "id": "id",
44     "type": "entity",
45     "bank_accounts": [
46       {
47         "id": "id",
48         "account_holder_name": "Bob Jones",
49         "account_number": "12345678",
50         "bic": "DEUTDEFFXXX",
51         "display_name": "Primary account",
52         "iban": "DE74500700100100000900",
53         "name": "Primary account",
54         "sort_code": "123456"
55       }
56     ],
57     "name": "name"
58   },
59   "payment_link_id": "payment_link_id",
60   "payment_reference": "payment_reference",
61   "provider": "provider",
62   "selected_payment_method": "sepa_credit"
63 }

Update the payment intent amount

Up Next

1	curl https://api.sandbox.monite.com/v1/payment_intents/payment_intent_id \
2	-H "x-monite-version: 2024-01-31" \
3	-H "x-monite-entity-id: x-monite-entity-id" \
4	-H "Authorization: Bearer <token>"

1	{
2	"id": "id",
3	"updated_at": "2024-01-15T09:30:00Z",
4	"amount": 1,
5	"currency": "currency",
6	"payment_methods": [
7	"sepa_credit"
8	],
9	"recipient": {
10	"id": "id",
11	"type": "entity",
12	"bank_accounts": [
13	{
14	"id": "id",
15	"account_holder_name": "Bob Jones",
16	"account_number": "12345678",
17	"bic": "DEUTDEFFXXX",
18	"display_name": "Primary account",
19	"iban": "DE74500700100100000900",
20	"name": "Primary account",
21	"sort_code": "123456"
22	}
23	],
24	"name": "name"
25	},
26	"status": "status",
27	"application_fee_amount": 1,
28	"batch_payment_id": "batch_payment_id",
29	"invoice": {
30	"due_date": "due_date",
31	"file": {
32	"mimetype": "mimetype",
33	"name": "name",
34	"url": "url"
35	},
36	"issue_date": "issue_date"
37	},
38	"object": {
39	"id": "id",
40	"type": "payable"
41	},
42	"payer": {
43	"id": "id",
44	"type": "entity",
45	"bank_accounts": [
46	{
47	"id": "id",
48	"account_holder_name": "Bob Jones",
49	"account_number": "12345678",
50	"bic": "DEUTDEFFXXX",
51	"display_name": "Primary account",
52	"iban": "DE74500700100100000900",
53	"name": "Primary account",
54	"sort_code": "123456"
55	}
56	],
57	"name": "name"
58	},
59	"payment_link_id": "payment_link_id",
60	"payment_reference": "payment_reference",
61	"provider": "provider",
62	"selected_payment_method": "sepa_credit"
63	}