Get payment link by ID

GET

/payment_links/:payment_link_id

Path parameters

payment_link_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

amountinteger

currencyenum

expires_atdatetime

payment_intent_idstring

payment_methodslist of strings

payment_page_urlstring>=1 character<=2083 characters

recipientobject

statusstring

invoiceobjectOptional

payerobjectOptional

payment_intentobjectOptional

payment_referencestringOptional

return_urlstringOptional

The URL where to redirect the payer after the payment. If return_url is specified, then after the payment is completed the payment page will display the “Return to platform” link that navigates to this URL.

Errors

GET

1 curl https://api.sandbox.monite.com/v1/payment_links/payment_link_id \
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   "id": "id",
3   "amount": 1,
4   "currency": "AED",
5   "expires_at": "2024-01-15T09:30:00Z",
6   "payment_intent_id": "payment_intent_id",
7   "payment_methods": [
8     "payment_methods"
9   ],
10   "payment_page_url": "payment_page_url",
11   "recipient": {
12     "id": "id",
13     "type": "entity",
14     "bank_accounts": [
15       {
16         "id": "id",
17         "account_holder_name": "Bob Jones",
18         "account_number": "12345678",
19         "bic": "DEUTDEFFXXX",
20         "display_name": "Primary account",
21         "iban": "DE74500700100100000900",
22         "name": "Primary account",
23         "sort_code": "123456"
24       }
25     ],
26     "name": "name"
27   },
28   "status": "status",
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   "payer": {
39     "id": "id",
40     "type": "entity",
41     "bank_accounts": [
42       {
43         "id": "id",
44         "account_holder_name": "Bob Jones",
45         "account_number": "12345678",
46         "bic": "DEUTDEFFXXX",
47         "display_name": "Primary account",
48         "iban": "DE74500700100100000900",
49         "name": "Primary account",
50         "sort_code": "123456"
51       }
52     ],
53     "name": "name"
54   },
55   "payment_intent": {
56     "id": "id",
57     "updated_at": "2024-01-15T09:30:00Z",
58     "status": "status",
59     "application_fee_amount": 1,
60     "object": {
61       "id": "id",
62       "type": "payable"
63     },
64     "provider": "provider",
65     "selected_payment_method": "selected_payment_method"
66   },
67   "payment_reference": "payment_reference",
68   "return_url": "https://pay.example.com/complete"
69 }

Expire a payment link

Up Next

1	curl https://api.sandbox.monite.com/v1/payment_links/payment_link_id \
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	"id": "id",
3	"amount": 1,
4	"currency": "AED",
5	"expires_at": "2024-01-15T09:30:00Z",
6	"payment_intent_id": "payment_intent_id",
7	"payment_methods": [
8	"payment_methods"
9	],
10	"payment_page_url": "payment_page_url",
11	"recipient": {
12	"id": "id",
13	"type": "entity",
14	"bank_accounts": [
15	{
16	"id": "id",
17	"account_holder_name": "Bob Jones",
18	"account_number": "12345678",
19	"bic": "DEUTDEFFXXX",
20	"display_name": "Primary account",
21	"iban": "DE74500700100100000900",
22	"name": "Primary account",
23	"sort_code": "123456"
24	}
25	],
26	"name": "name"
27	},
28	"status": "status",
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	"payer": {
39	"id": "id",
40	"type": "entity",
41	"bank_accounts": [
42	{
43	"id": "id",
44	"account_holder_name": "Bob Jones",
45	"account_number": "12345678",
46	"bic": "DEUTDEFFXXX",
47	"display_name": "Primary account",
48	"iban": "DE74500700100100000900",
49	"name": "Primary account",
50	"sort_code": "123456"
51	}
52	],
53	"name": "name"
54	},
55	"payment_intent": {
56	"id": "id",
57	"updated_at": "2024-01-15T09:30:00Z",
58	"status": "status",
59	"application_fee_amount": 1,
60	"object": {
61	"id": "id",
62	"type": "payable"
63	},
64	"provider": "provider",
65	"selected_payment_method": "selected_payment_method"
66	},
67	"payment_reference": "payment_reference",
68	"return_url": "https://pay.example.com/complete"
69	}