SchemaPaymentsPayment Links

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 contains the following settings for the payment link:

  • 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. The response contains a paymentLinkId that you can use to share the payment link or to retrieve information about the link.

Path parameters

processingTerminalIdstringRequired>=4 characters<=50 characters

Unique identifier that we assigned to the terminal.

Headers

AuthorizationstringRequired

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

Idempotency-KeystringRequired

Unique identifier that you generate for each request. You must use the UUID v4 format for the identifier. For more information about the idempotency key, go to Idempotency.

Request

This endpoint expects an object.
OR

Response

Successful request. We created the payment link.

OR