Sign in
paymentLinks

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 method.

post/processing-terminals/{processingTerminalId}/payment-links

Path parameters

processingTerminalIdstring required

Unique identifier that we assigned to the terminal.

Headers

Authorizationstring required

Bearer authentication

Idempotency-Keystring uuid required

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 body

OR

Response

Successful request. We return a polymorphic object that contains payment link information. The value of the type parameter determines which variant you should use:

  • multiUse - Create a link that the merchant can use to take multiple payments.
  • singleUse - Create a link that the merchant can use for only one payment.
OR

Changes