Creates a Paylink resource.
This endpoint allows you to create a new paylink to a payment page for your debtor. You can serve the paylink to a customer in any way you choose (on your own website, chat message or integrated in your own email or SMS).
The response contains a payment URL and our unique identifier for this paylink: paylink_id. It is recommended that you store the paylink_id in your system for future status requests.
You can redirect the customer to this page and after a payment attempt (successful or not), the customer will be redirected to the return_url if one is specified in the request.
Optionally, our system can add the paylink_id and status as URL parameters to the return URL.
### Payment modules
The payment modules are the payment modules that you have activated in your POM account.
Supported payment modules are:
- ideal
- credit_card
- bancontact
- emandate_one_off
- emandate_recurring
- bank_transfer
- paypal
- sofort
- pay_safe_card
- ubl
- giropay
- psd2
- in3
- via_cash
- apple_pay
- amazon_payment
- pay_by_bank
- carte_bancaire
- bancontact_ocp
- start_token_recurring
- start_token_paymentplan
- google_pay
- bizum
Note: The payment modules emandate_one_off and emandate_recurring cannot be used together.
curl -X POST "/v3/paylinks" \
-H "Authorization: Bearer $POM_API_DOCUMENTATION_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"first_name": "John",
"last_name": "Doe",
"debtor_number": 123456,
"payment_reference": 123456789,
"concerning": "Rent April 2025",
"batch_name": "Batch_2025-05-01",
"request_id": "1234567890",
"company_name": "POM B.V.",
"username": "John Doe",
"variable1": "variable1",
"variable2": "variable2",
"variable3": "variable3",
"variable4": "variable4",
"variable5": "variable5",
"due_date": "2025-05-01",
"return_url": "https://example.nl/payment",
"cid": 1234567890
}'Authorization
AuthorizationstringheaderrequiredOAuth 2.0 client credentials Grant
Body
The new Paylink resource
first_namestringlast_namestringrequireddebtor_numberstringrequiredpayment_referencestringrequiredconcerningstringrequiredThe subject of the payment request. If you are collecting an invoice for another company, specify the company name here.
batch_namestringrequiredrequest_idstringYour unique identifier for this single request.
company_namestringusernamestringName of employee making this request. Useful for tracking employee performance when making single requests.
variable1stringFree text. This parameter can be displayed in a message template.
variable2stringFree text. This parameter can be displayed in a message template.
variable3stringFree text. This parameter can be displayed in a message template.
variable4stringFree text. This parameter can be displayed in a message template.
variable5stringFree text. This parameter can be displayed in a message template.
due_datestring<date-time>requiredreturn_urlstringCustomer is redirected to this URI after the payment process. Optionally, our system can add the paylink ID and status as URL parameters to the return URL.
cidinteger | nullCollection order ID the paylink could be joined to. This will make sure the payment is synced. In most cases payments will be automatically synced based on payment_reference.
payment_modulesenum<string>[]One of:idealcredit_cardbancontactemandate_one_offemandate_recurringbank_transferpaypalsofortpay_safe_cardublgiropaypsd2in3via_cashapple_payamazon_paymentpay_by_bankcarte_bancairebancontact_ocpstart_token_recurringstart_token_paymentplangoogle_paybizuminvoicesPaylinkInvoice-paylink.write[]
Response
Paylink resource created
paylink_idintegerpaylinkstring
{
"paylink_id": 0,
"paylink": "string"
}