Retrieve payment link | Payroc

using Payroc;
using System.Threading.Tasks;
using Payroc.PaymentLinks;
namespace Usage;
public class Example
{
    public async Task Do() {
        var client = new BasePayrocClient(
            clientOptions: new ClientOptions {
                Environment = PayrocEnvironment.Production
            }
        );
        await client.PaymentLinks.RetrieveAsync(
            new RetrievePaymentLinksRequest {
                PaymentLinkId = "JZURRJBUPS"
            }
        );
    }
}

{
  "type": "multiUse",
  "paymentLinkId": "JZURRJBUPS",
  "merchantReference": "LinkRef6543",
  "order": {
    "description": "Pie It Forward charitable trust donation",
    "charge": {
      "type": "prompt",
      "currency": "USD"
    }
  },
  "authType": "sale",
  "paymentMethods": [
    "card",
    "bankTransfer"
  ],
  "customLabels": [
    {
      "element": "paymentButton",
      "label": "SUPPORT US"
    }
  ],
  "assets": {
    "paymentUrl": "https://payments.payroc.com/merchant/pay-by-link?token=02ada211-ff51-4845-b0b5-e685aeb4b19d",
    "paymentButton": "<a href=\"https://payments.payroc.com/merchant/pay-by-link?token=02ada211-ff51-4845-b0b5-e685aeb4b19d\" \ntarget=\"_blank\" style=\"color: #ffffff; background-color: #6C7A89; font-size: 18px; font-family: Helvetica, Arial, sans-serif; \ntext-decoration: none; border-radius: 30px; padding: 14px 28px; display: inline-block;\">SUPPORT US</a>\n"
  },
  "status": "active",
  "createdOn": "2024-09-24"
}

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.

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](https://docs.payroc.com/api/schema/payment-links/create) method. **Note:** If you don't have the paymentLinkId, use our [List Payment Links](https://docs.payroc.com/api/schema/payment-links/list) 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.

Authentication

AuthorizationBearer

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

Path parameters

paymentLinkIdstringRequired=10 characters

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.

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.

multiUseobject

singleUseobject

Authentication

Path parameters

Response

Errors