Get payment link by ID

GET

/payment_links/:payment_link_id

GET

/v1/payment_links/:payment_link_id

$ curl https://api.sandbox.monite.com/v1/payment_links/payment_link_id \
>      -H "x-monite-version: 2024-05-25" \
>      -H "x-monite-entity-id: 9d2b4c8f-2087-4738-ba91-7359683c49a4" \
>      -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         "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": "application/pdf",
38       "name": "INV-00042.pdf",
39       "url": "https://example.com/path/to/invoice.pdf"
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 }

curl https://api.sandbox.monite.com/v1/payment_links/payment_link_id \
     -H "x-monite-version: 2024-05-25" \
     -H "x-monite-entity-id: 9d2b4c8f-2087-4738-ba91-7359683c49a4" \
     -H "Authorization: Bearer <token>"

{
  "id": "id",
  "amount": 1,
  "currency": "AED",
  "expires_at": "2024-01-15T09:30:00Z",
  "payment_intent_id": "payment_intent_id",
  "payment_methods": [
    "payment_methods"
  ],
  "payment_page_url": "payment_page_url",
  "recipient": {
    "id": "id",
    "type": "entity",
    "bank_accounts": [
      {
        "id": "id",
        "account_holder_name": "Bob Jones",
        "account_number": "12345678",
        "bic": "DEUTDEFFXXX",
        "country": "AF",
        "currency": "AED",
        "display_name": "Primary account",
        "iban": "DE74500700100100000900",
        "is_default": true,
        "name": "Primary account",
        "routing_number": "routing_number",
        "sort_code": "123456",
        "was_created_by_user_id": "was_created_by_user_id"
      }
    ],
    "name": "name"
  },
  "status": "status",
  "invoice": {
    "due_date": "due_date",
    "file": {
      "mimetype": "application/pdf",
      "name": "INV-00042.pdf",
      "url": "https://example.com/path/to/invoice.pdf"
    },
    "issue_date": "issue_date"
  },
  "payer": {
    "id": "id",
    "type": "entity",
    "bank_accounts": [
      {
        "id": "id",
        "account_holder_name": "Bob Jones",
        "account_number": "12345678",
        "bic": "DEUTDEFFXXX",
        "country": "AF",
        "currency": "AED",
        "display_name": "Primary account",
        "iban": "DE74500700100100000900",
        "is_default": true,
        "name": "Primary account",
        "routing_number": "routing_number",
        "sort_code": "123456",
        "was_created_by_user_id": "was_created_by_user_id"
      }
    ],
    "name": "name"
  },
  "payment_intent": {
    "id": "id",
    "updated_at": "2024-01-15T09:30:00Z",
    "status": "status",
    "application_fee_amount": 1,
    "object": {
      "id": "id",
      "type": "payable"
    },
    "provider": "provider",
    "selected_payment_method": "selected_payment_method"
  },
  "payment_reference": "payment_reference",
  "return_url": "https://pay.example.com/complete"
}

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

payment_link_idstringRequired

Response

Successful Response

idstringformat: "uuid"

amountinteger

currencyenum

expires_atdatetime

payment_intent_idstringformat: "uuid"

payment_methodslist of strings

payment_page_urlstringformat: "uri"1-2083 characters

recipientobject

statusstring

invoiceobject

payerobject

payment_intentobject

payment_referencestring

return_urlstring

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

401

Get Payment Links ID Request Unauthorized Error

422

Get Payment Links ID Request Unprocessable Entity Error

429

Get Payment Links ID Request Too Many Requests Error

Get payment link by ID

Get payment link by ID

Authentication

Path parameters

Headers

Response

Errors

Authentication

Path parameters

Headers

Response

Errors

$	curl https://api.sandbox.monite.com/v1/payment_links/payment_link_id \
>	-H "x-monite-version: 2024-05-25" \
>	-H "x-monite-entity-id: 9d2b4c8f-2087-4738-ba91-7359683c49a4" \
>	-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	"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": "application/pdf",
38	"name": "INV-00042.pdf",
39	"url": "https://example.com/path/to/invoice.pdf"
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	}