Create payment link
Use this method to create a payment link that a customer can use to make a payment for goods or services.
The request includes the following settings:
- **type** - Indicates whether the link can be used only once or if it can be used multiple times.
- **authType** - Indicates whether the transaction is a sale or a pre-authorization.
- **paymentMethod** - Indicates the payment methods that the merchant accepts.
- **charge** - Indicates whether the merchant or the customer enters the amount for the transaction.
If your request is successful, our gateway returns a paymentLinkId, which you can use to perform follow-on actions.
**Note:** To share the payment link with a customer, use our [Share Payment Link](https://docs.payroc.com/api/schema/payments/payment-links/sharing-events/share) method.
Path parameters
processingTerminalId
Unique identifier that we assigned to the terminal.
Headers
Authorization
Bearer authentication of the form Bearer <token>
, where token is your auth token.
Idempotency-Key
Unique identifier that you generate for each request. You must use the [UUID v4 format](https://www.rfc-editor.org/rfc/rfc4122) for the identifier. For more information about the idempotency key, go to [Idempotency](https://docs.payroc.com/api/idempotency).
Request
This endpoint expects an object.
Multi-use link
OR
Single-use link
Response
Successful request. We created the payment link.
Multi-use link
OR
Single-use link