Create a payment link
Create a new payment link for an accounts payble invoice (to be paid by the entity) or an accounts receivable invoice (to be sent to the counterpart).
Headers
Bearer authentication of the form Bearer <token>, where token is your auth token.
Request
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.
Specifies the invoice vendor - entity or counterpart. This is the payee, or the recipient of the payment.
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
ispayable
,amount
must not be specified since it’s taken from the payable. - If
object.type
isreceivable
, you can provide a customamount
value to create a partial payment link. In this case, theamount
value must not exceed the invoice’samount_to_pay
minus all active payment links.
- If
The payment currency. Mutually exclusive with object
.
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.
An object containing information about an external invoice to be paid. Mutually exclusive with 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.
A payment reference number that the recipient can use to identify the payer or purpose of the transaction. Mutually exclusive with object
.
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
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.