PaymentsPayment links

Create a payment link

Authentication

AuthorizationBearer

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

Headers

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-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-2083 characters
recipientobject
statusstring
invoiceobject or null
payerobject or null
payment_intentobject or null
payment_referencestring or null
return_urlstring or null

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