Technical Document · Portfolio Sample
Payment Links
This page explains Payment Link workflow and code. It does not explain Rapyd Checkout's workflow or code, which assumes you are already familiar with.
Definition
A Payment Link is a reusable hosted payment page that accepts fixed or customer-defined amounts — designed to be shared via SMS, WhatsApp, or email, rather than embedded in a specific transaction flow.
Payment Link Workflow
You
- Generate a payment link via API request.
The customer
- Clicks on the payment link — a pre-payment page is displayed.
- Sees a fixed amount OR enters a custom amount to pay.
- Clicks Continue.
Rapyd
- Redirects the customer to the payment page.
The customer
- Completes the payment with their desired payment method.
Rapyd
- Sends a webhook.
You
- Notify the customer.
Create Payment Link
The following tables describe the path and body parameters for the Create Payment Link API request.
Path Parameters
| Parameter | Required | Description |
|---|---|---|
| max_payments | no | The number of times a payment link can be used for payment before expiring. |
Body Parameters
| Parameter | Required | Description |
|---|---|---|
| amount | yes | The amount of the payment, in units of the currency defined in currency. |
| country | yes | The two-letter ISO 3166-1 ALPHA-2 code for the country. |
| currency | yes | The currency of the transaction. Three-letter ISO 4217 code. |
| fixed_side | no | Indicates whether the fixed amount applies to the buyer or the seller. See Payment Links With FX. |
| requested_currency | no | The currency of the fixed side in an FX transaction. Three-letter ISO 4217 code. See Payment Links With FX. |
Payment Links With FX
Definition
Foreign Exchange (FX) allows your customer to pay in their local currency while you receive the funds in a different currency. Rapyd handles the conversion automatically.
Use the following fields to configure the FX conversion:
- fixed_side — specifies whether the buyer or seller pays a fixed amount.
- requested_currency — defines the currency of the fixed side.