Skip to main content
POST
/
payment_links
curl --request POST \ --url https://api.sandbox.monite.com/v1/payment_links \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --header 'x-monite-entity-id: <x-monite-entity-id>' \ --header 'x-monite-version: <x-monite-version>' \ --data ' { "object": { "type": "payable", "id": "5940eb3a-de95-4e7e-b5e7-8a4ad0ea341b" }, "recipient": { "type": "counterpart", "id": "6296af34-6feb-43c1-b567-83e3bf45050c" }, "payment_methods": [ "sepa_credit" ], "return_url": "https://example.com/where-to-redirect-after-payment" } '
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "amount": 123,
  "currency": "AED",
  "expires_at": "2023-11-07T05:31:56Z",
  "payment_intent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "payment_methods": [
    "<string>"
  ],
  "payment_page_url": "<string>",
  "recipient": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "entity",
    "bank_accounts": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "account_holder_name": "<string>",
        "account_number": "<string>",
        "bic": "<string>",
        "country": "DE",
        "currency": "EUR",
        "display_name": "<string>",
        "iban": "<string>",
        "is_default": false,
        "name": "<string>",
        "routing_number": "<string>",
        "sort_code": "<string>",
        "was_created_by_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      }
    ],
    "name": "<string>"
  },
  "status": "<string>",
  "invoice": {
    "due_date": "2023-12-25",
    "file": {
      "mimetype": "<string>",
      "name": "<string>",
      "url": "<string>"
    },
    "issue_date": "2023-12-25"
  },
  "payer": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "entity",
    "bank_accounts": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "account_holder_name": "<string>",
        "account_number": "<string>",
        "bic": "<string>",
        "country": "DE",
        "currency": "EUR",
        "display_name": "<string>",
        "iban": "<string>",
        "is_default": false,
        "name": "<string>",
        "routing_number": "<string>",
        "sort_code": "<string>",
        "was_created_by_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      }
    ],
    "name": "<string>"
  },
  "payment_intent": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "updated_at": "2023-11-07T05:31:56Z",
    "status": "<string>",
    "application_fee_amount": 123,
    "object": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "payable"
    },
    "provider": "<string>",
    "selected_payment_method": "<string>"
  },
  "payment_reference": "<string>",
  "return_url": "https://pay.example.com/complete"
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
x-monite-version
string<date>
required
​
x-monite-entity-id
string<uuid>
required

The ID of the entity that owns the requested resource.

Example:

"9d2b4c8f-2087-4738-ba91-7359683c49a4"

Body

application/json
​
payment_methods
enum<string>[]
required

Payment methods to be displayed on the payment page. These payment methods must already be enabled for the entity.

Note: Available payment methods vary per country, transaction type (B2B or B2C), and the payment link type (entity pays a bill or entity generates an invoice payment link for its counterpart). For more information, see Payment methods.

Minimum array length: 1
Available options:
sepa_credit,
us_ach,
blik,
card,
bacs_direct_debit,
bancontact,
eps,
giropay,
ideal,
p24,
sepa_debit,
sofort,
applepay,
googlepay,
affirm,
klarna
​
recipient
object
required

Specifies the invoice vendor - entity or counterpart. This is the payee, or the recipient of the payment.

​
amount
integer

The payment amount in minor units. The usage of the amount field depends on the type of the payment link you are creating:

  • If the invoice object is specified (that is, when creating a payment link for an external invoice), amount is required.
  • If object is specified:
    • If object.type is payable, amount must not be specified since it's taken from the payable.
    • If object.type is receivable, you can provide a custom amount value to create a partial payment link. In this case, the amount value must not exceed the invoice's amount_to_pay minus all active payment links.
Required range: x >= 1
Example:

120550

​
currency
enum<string>

The payment currency. Mutually exclusive with object.

Available options:
AED,
AFN,
ALL,
AMD,
ANG,
AOA,
ARS,
AUD,
AWG,
AZN,
BAM,
BBD,
BDT,
BGN,
BHD,
BIF,
BMD,
BND,
BOB,
BRL,
BSD,
BTN,
BWP,
BYN,
BZD,
CAD,
CDF,
CHF,
CLP,
CNY,
COP,
CRC,
CVE,
CZK,
DJF,
DKK,
DOP,
DZD,
EGP,
ETB,
EUR,
FJD,
FKP,
GBP,
GEL,
GHS,
GIP,
GMD,
GNF,
GTQ,
GYD,
HKD,
HNL,
HTG,
HUF,
IDR,
ILS,
INR,
IQD,
ISK,
JMD,
JOD,
JPY,
KES,
KGS,
KHR,
KMF,
KRW,
KWD,
KYD,
KZT,
LAK,
LBP,
LKR,
LRD,
LSL,
LYD,
MAD,
MDL,
MGA,
MKD,
MMK,
MNT,
MOP,
MUR,
MVR,
MWK,
MXN,
MYR,
MZN,
NAD,
NGN,
NIO,
NOK,
NPR,
NZD,
OMR,
PAB,
PEN,
PGK,
PHP,
PKR,
PLN,
PYG,
QAR,
RON,
RSD,
RUB,
RWF,
SAR,
SBD,
SCR,
SEK,
SGD,
SHP,
SLE,
SOS,
SRD,
SSP,
SVC,
SZL,
THB,
TJS,
TMT,
TND,
TOP,
TRY,
TTD,
TWD,
TZS,
UAH,
UGX,
USD,
UYU,
UZS,
VND,
VUV,
WST,
XAF,
XCD,
XOF,
XPF,
YER,
ZAR,
ZMW
Example:

"EUR"

​
expires_at
string<date-time>

Date and time (in the ISO 8601 format) when this payment link will expire. Can be up to 70 days from the current date and time. If omitted:

  • Payment links for payables and receivables expire 30 days after the invoice due date.
  • Payment links for external invoices expire 30 days after the link creation time.

For more information, see Payment link expiration.

​
invoice
object

An object containing information about an external invoice to be paid. Mutually exclusive with object.

​
object
object

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_reference
string

A payment reference number that the recipient can use to identify the payer or purpose of the transaction. Mutually exclusive with object.

Example:

"INV-00042"

​
return_url
string<uri>

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.

Required string length: 1 - 2083
Example:

"https://pay.example.com/complete"

Response

Successful Response

​
id
string<uuid>
required
​
amount
integer
required
​
currency
enum<string>
required
Available options:
AED,
AFN,
ALL,
AMD,
ANG,
AOA,
ARS,
AUD,
AWG,
AZN,
BAM,
BBD,
BDT,
BGN,
BHD,
BIF,
BMD,
BND,
BOB,
BRL,
BSD,
BTN,
BWP,
BYN,
BZD,
CAD,
CDF,
CHF,
CLP,
CNY,
COP,
CRC,
CVE,
CZK,
DJF,
DKK,
DOP,
DZD,
EGP,
ETB,
EUR,
FJD,
FKP,
GBP,
GEL,
GHS,
GIP,
GMD,
GNF,
GTQ,
GYD,
HKD,
HNL,
HTG,
HUF,
IDR,
ILS,
INR,
IQD,
ISK,
JMD,
JOD,
JPY,
KES,
KGS,
KHR,
KMF,
KRW,
KWD,
KYD,
KZT,
LAK,
LBP,
LKR,
LRD,
LSL,
LYD,
MAD,
MDL,
MGA,
MKD,
MMK,
MNT,
MOP,
MUR,
MVR,
MWK,
MXN,
MYR,
MZN,
NAD,
NGN,
NIO,
NOK,
NPR,
NZD,
OMR,
PAB,
PEN,
PGK,
PHP,
PKR,
PLN,
PYG,
QAR,
RON,
RSD,
RUB,
RWF,
SAR,
SBD,
SCR,
SEK,
SGD,
SHP,
SLE,
SOS,
SRD,
SSP,
SVC,
SZL,
THB,
TJS,
TMT,
TND,
TOP,
TRY,
TTD,
TWD,
TZS,
UAH,
UGX,
USD,
UYU,
UZS,
VND,
VUV,
WST,
XAF,
XCD,
XOF,
XPF,
YER,
ZAR,
ZMW
​
expires_at
string<date-time>
required
​
payment_intent_id
string<uuid>
required
​
payment_methods
string[]
required
​
payment_page_url
string<uri>
required
Required string length: 1 - 2083
​
recipient
object
required
​
status
string
required
​
invoice
object
​
payer
object
​
payment_intent
object
​
payment_reference
string
​
return_url
string

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.

Example:

"https://pay.example.com/complete"