Create a payment link — Monite Documentation

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.

Request

This endpoint expects an object.

payment_methodslist of enumsRequired

recipientobjectRequired

amountintegerOptional>=1

The payment amount in minor units. Required if object is not specified.

currencyenumOptional

The payment currency. Required if object is not specified.

expires_atdatetimeOptional

invoiceobjectOptional

An object containing information about the invoice being paid. Used only if object is not specified.

objectobjectOptional

If the invoice being paid is a payable or receivable stored in Monite, provide the object object containing the invoice type and ID. Otherwise, use the amount, currency, payment_reference, and (optionally) invoice fields to specify the invoice-related data.

payment_referencestringOptional

A payment reference number that the recipient can use to identify the payer or purpose of the transaction. Required if object is not specified.

return_urlstringOptionalformat: "uri">=1 character<=2083 characters

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.

Response

Successful Response

idstringformat: "uuid"

amountinteger

currencyenum

expires_atdatetime

payment_intent_idstringformat: "uuid"

payment_methodslist of strings

payment_page_urlstringformat: "uri">=1 character<=2083 characters

recipientobject

statusstring

invoiceobjectOptional

payerobjectOptional

payment_intentobjectOptional

payment_referencestringOptional

return_urlstringOptional

Errors

1 curl -X POST https://api.sandbox.monite.com/v1/payment_links \ 2 -H "x-monite-version: 2024-05-25" \ 3 -H "x-monite-entity-id: 9d2b4c8f-2087-4738-ba91-7359683c49a4" \ 4 -H "Authorization: Bearer <token>" \ 5 -H "Content-Type: application/json" \ 6 -d '{ 7 "payment_methods": [ 8 "sepa_credit" 9 ], 10 "recipient": { 11 "id": "id", 12 "type": "entity" 13 } 14 }'

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 "country": "AF", 21 "currency": "AED", 22 "display_name": "Primary account", 23 "iban": "DE74500700100100000900", 24 "is_default": true, 25 "name": "Primary account", 26 "routing_number": "routing_number", 27 "sort_code": "123456", 28 "was_created_by_user_id": "was_created_by_user_id" 29 } 30 ], 31 "name": "name" 32 }, 33 "status": "status", 34 "invoice": { 35 "due_date": "due_date", 36 "file": { 37 "mimetype": "mimetype", 38 "name": "name", 39 "url": "url" 40 }, 41 "issue_date": "issue_date" 42 }, 43 "payer": { 44 "id": "id", 45 "type": "entity", 46 "bank_accounts": [ 47 { 48 "id": "id", 49 "account_holder_name": "Bob Jones", 50 "account_number": "12345678", 51 "bic": "DEUTDEFFXXX", 52 "country": "AF", 53 "currency": "AED", 54 "display_name": "Primary account", 55 "iban": "DE74500700100100000900", 56 "is_default": true, 57 "name": "Primary account", 58 "routing_number": "routing_number", 59 "sort_code": "123456", 60 "was_created_by_user_id": "was_created_by_user_id" 61 } 62 ], 63 "name": "name" 64 }, 65 "payment_intent": { 66 "id": "id", 67 "updated_at": "2024-01-15T09:30:00Z", 68 "status": "status", 69 "application_fee_amount": 1, 70 "object": { 71 "id": "id", 72 "type": "payable" 73 }, 74 "provider": "provider", 75 "selected_payment_method": "selected_payment_method" 76 }, 77 "payment_reference": "payment_reference", 78 "return_url": "https://pay.example.com/complete" 79 }

1	curl -X POST https://api.sandbox.monite.com/v1/payment_links \
2	-H "x-monite-version: 2024-05-25" \
3	-H "x-monite-entity-id: 9d2b4c8f-2087-4738-ba91-7359683c49a4" \
4	-H "Authorization: Bearer <token>" \
5	-H "Content-Type: application/json" \
6	-d '{
7	"payment_methods": [
8	"sepa_credit"
9	],
10	"recipient": {
11	"id": "id",
12	"type": "entity"
13	}
14	}'

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	"country": "AF",
21	"currency": "AED",
22	"display_name": "Primary account",
23	"iban": "DE74500700100100000900",
24	"is_default": true,
25	"name": "Primary account",
26	"routing_number": "routing_number",
27	"sort_code": "123456",
28	"was_created_by_user_id": "was_created_by_user_id"
29	}
30	],
31	"name": "name"
32	},
33	"status": "status",
34	"invoice": {
35	"due_date": "due_date",
36	"file": {
37	"mimetype": "mimetype",
38	"name": "name",
39	"url": "url"
40	},
41	"issue_date": "issue_date"
42	},
43	"payer": {
44	"id": "id",
45	"type": "entity",
46	"bank_accounts": [
47	{
48	"id": "id",
49	"account_holder_name": "Bob Jones",
50	"account_number": "12345678",
51	"bic": "DEUTDEFFXXX",
52	"country": "AF",
53	"currency": "AED",
54	"display_name": "Primary account",
55	"iban": "DE74500700100100000900",
56	"is_default": true,
57	"name": "Primary account",
58	"routing_number": "routing_number",
59	"sort_code": "123456",
60	"was_created_by_user_id": "was_created_by_user_id"
61	}
62	],
63	"name": "name"
64	},
65	"payment_intent": {
66	"id": "id",
67	"updated_at": "2024-01-15T09:30:00Z",
68	"status": "status",
69	"application_fee_amount": 1,
70	"object": {
71	"id": "id",
72	"type": "payable"
73	},
74	"provider": "provider",
75	"selected_payment_method": "selected_payment_method"
76	},
77	"payment_reference": "payment_reference",
78	"return_url": "https://pay.example.com/complete"
79	}