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_urlstringOptional=1 character

Response

Successful Response

idstring

amountinteger

currencyenum

expires_atdatetime

payment_intent_idstring

payment_methodslist of strings

payment_page_urlstring=1 character

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-01-31" \ 3 -H "x-monite-entity-id: x-monite-entity-id" \ 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 "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": "return_url" 69 }

1	curl -X POST https://api.sandbox.monite.com/v1/payment_links \
2	-H "x-monite-version: 2024-01-31" \
3	-H "x-monite-entity-id: x-monite-entity-id" \
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	"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": "return_url"
69	}