paymentLinks

Retrieve payment link

Changed on

Use this method to retrieve information about a payment link.

To retrieve a payment link, you need its paymentLinkId. Our gateway returned the paymentLinkId in the response of the Create Payment Link method.

Note: If you don't have the paymentLinkId, use our List Payment Links method to search for the payment link.

Our gateway returns the following information about 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.
  • paymentMethods - Indicates the payment method that the merchant accepts.
  • charge - Indicates whether the merchant or the customer enters the amount for the transaction.
  • status - Indicates if the payment link is active.
get/payment-links/{paymentLinkId}

Request

  • Base URL
    https://api.payroc.com/v1
  • URL
    https://api.payroc.com/v1/payment-links/{paymentLinkId}
  • Auth
    HTTP bearer

Path parameters

paymentLinkIdstring required

Unique identifier that we assigned to the payment link.

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