APIMatic Adyen APIs
Sign Up to APIMatic
HomeSDKsAPI ReferenceContext Plugin
CheckoutPayment links

Get a payment link

GET
/paymentLinks/{linkId}

Retrieves the payment link details using the payment link id.

Authorization

AuthorizationBasic <token>

In: header

Path Parameters

linkId*string

Unique identifier of the payment link.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/paymentLinks/string"
{  "amount": {    "currency": "EUR",    "value": 8700  },  "countryCode": "NL",  "expiresAt": "2021-04-08T14:06:39Z",  "merchantAccount": "YOUR_MERCHANT_ACCOUNT",  "reference": "shopper-reference-ekvL83",  "shopperLocale": "hu-HU",  "shopperReference": "shopper-reference-LZfdWZ",  "status": "active",  "url": "https://test.adyen.link/PL61C53A8B97E6915A",  "id": "PL61C53A8B97E6915A"}

Create a payment link POST

Creates a payment link to a [Pay by Link](https://docs.adyen.com/unified-commerce/pay-by-link/) page where the shopper can pay. The list of payment methods presented to the shopper depends on the `currency` and `country` parameters sent in the request. For more information, refer to [Pay by Link documentation](https://docs.adyen.com/online-payments/pay-by-link#create-payment-links-through-api).

Update the status of a payment link PATCH

Updates the status of a payment link. Use this endpoint to [force the expiry of a payment link](https://docs.adyen.com/online-payments/pay-by-link#update-payment-link-status).