Get a link
Get a single view of a link using the Global Payments link id.
Get a single view of a link using the Global Payments ID. Availability of this feature in production depends on your allowed live configuration. Please contact Global Payments before coding this feature to confirm it will be available to you when you go live.
Authorization
bearerAuth Access token from POST /accesstoken, sent as Authorization: Bearer <token>.
In: header
Path Parameters
A unique identifier generated by Global Payments to identify the link.
Header Parameters
The version of the API to execute the request.
1 <= length <= 50"2021-03-22"Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/links/LNK_bnqlo0LgbMt221TczxF70Awdg7c5ez" \ -H "X-GP-Version: 2021-03-22"{ "merchant_id": "MER_880c34767b184d5e82b10e767201e648", "merchant_name": "Curtis_Douglas49", "account_id": "FMA_2d4ddd693ff7448b97ea420b13aecac2", "account_name": "718575802_978769", "id": "LNK_bnqlo0LgbMt221TczxF70Awdg7c5ez", "url": "https://il01merchantportals.propay.com/ProPayCard/Index?authToken=91e981e3-ec11-418c-bf80-2b828c8a5b0f&accountnum=718575797", "status": "ACTIVE", "type": "THIRD_PARTY_PAGE", "usage_mode": "SINGLE", "usage_limit": "5", "reference": "stringst", "name": "Mobile Bill Payment", "description": "February and March Invoice", "shippable": "YES", "shipping_amount": "1000", "usage_count": "5", "viewed_count": 10, "expiration_date": "2025-12-20T23:59:59Z", "images": [ "string" ], "transactions": [ { "amount": "11099", "channel": "CP", "country": "US", "currency": "USD", "allowed_payment_methods": [ "CARD" ], "transaction_list": [ { "id": "TRN_uzFr7t4VOqxdLDI44hHmXIjHtOOE", "time_created": "2021-10-01", "status": "INITIATED", "type": "SALE", "channel": "CP", "amount": "11099", "currency": "USD", "reference": "becf9f3e-4d33-459c-8ed2-0c4affc9555e" } ] } ], "action": { "id": "ACT_uzFr7t4VOqxdLDI44hHmXIjHtOOE8d", "type": "LINK_CREATE", "time_created": "2021-05-03T21:23:39.718Z", "result_code": "SUCCESS", "app_id": "uzFr7t4VOqxdLDI44hHmXIjHtOOE8d", "app_name": "my_lovely_app" }}Create a link POST
Create a new link The PayLink API allows you to generate single or multi-use unique payment links. These links can be sent to consumers. You can send these links to your customers via any channel, for example, email, SMS etc. When the customer clicks on the link they will be redirected to a page where they can make a payment. Availability of this feature in production depends on your allowed live configuration. Please contact Global Payments before coding this feature to confirm it will be available to you when you go live.
Get Merchants GET
Get Merchants within a Partner Program.