Create a payment link | Monite Documentation

curl -X POST https://api.sandbox.monite.com/v1/payment_links \
     -H "x-monite-version: 2023-09-01" \
     -H "x-monite-entity-id: 9d2b4c8f-2087-4738-ba91-7359683c49a4" \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "payment_methods": [
    "sepa_credit"
  ],
  "recipient": {
    "id": "id",
    "type": "entity"
  }
}'

{
  "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": "mimetype",
      "name": "name",
      "url": "url"
    },
    "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.

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.

The payment amount in [minor units](https://docs.monite.com/references/currencies#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

payerobject

payment_intentobject

payment_referencestring

return_urlstring

Errors

422

Post Payment Links Request Unprocessable Entity Error

500

Post Payment Links Request Internal Server Error