Get a list of Links
Get a list of links recently processed, using criteria passed in the query string. Page through the result set to access all records.
Get a list of links recently processed, using criteria passedin the query string. Page through the result set to access all records. 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
Query Parameters
The start time to search for in a range, using the resource time_created value.
dateThe end time to search for in a range, using the resource time_created value.
dateA unique identifier generated by Global Payments to identify the link.
The overall status of the instance of the resource.The overall status of the instance of the resource.
*ACTIVE - When a link is initially created it is in an ACTIVE status waiting to be paid. Links can only be paid when they are in a ACTIVE status.
*CLOSED - When a multi use link is paid it max number of time it is updated to be CLOSED automatically. A CLOSED link cannot be paid again.
*PAID - When a single use link is paid once then its status is updated to PAID automatically. A PAID link cannot be paid again.
*INACTIVE - An INACTIVE link is a link that you have marked as INACTIVE. Links can be manually updated / toggled between ACTIVE and INACTIVE using the PATCH request. A link cannot be paid while it is in an INACTIVE state.
*EXPIRED - An EXPIRED link is a link the expiration_date set in the request is in the past.
Value in
- "ACTIVE"
- "INACTIVE"
- "CLOSED"
- "EXPIRED"
- "PAID"
Indicates whether the link can be used once or multiple times
Value in
- "SINGLE"
- "MULTIPLE"
A descriptive name for the link. This will be visible to the customer on the payment page.
1 <= length <= 120A detailed description of your link that will be visible to the customer on the payment page.
1 <= length <= 250Merchant defined field to reference the transaction.
8 <= length <= 50The country in ISO-3166-1 (alpha-2 code) format.
The amount to transfer between Payer and Merchant for a SALE or a REFUND. It is always represented in the lowest denomination of the related currency.
The currency of the amount in ISO-4217(alpha-3)
3 <= length <= 3Indicates if you want to capture the customers shipping information on the hosted payment page. If you enable this field you can also set an optional shipping fee in the shipping_amount.
Value in
- "YES"
- "NO"
Indicates the date and time after which the link can no longer be used or paid. Please note that the timezone is in UTC+0
Indicates the page sequence to return in the response. The number of records presented on each page is determined by page_size field.1 means the first page, 2 the second and so on.
1The total number of records to return in a single page for a list. page:
5The field to order the list by.
"TIME_CREATED"The direction of the ordering of the entire list, ASC or DESC
"DESC"Value in
- "ASC"
- "DESC"
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" \ -H "X-GP-Version: 2021-03-22"{ "total_record_count": 1000, "current_page_size": 564, "merchant_id": "MER_880c34767b184d5e82b10e767201e648", "merchant_name": "Curtis_Douglas49", "account_id": "FMA_2d4ddd693ff7448b97ea420b13aecac2", "account_name": "718575802_978769", "filter": { "from_time_created": "2022-05-01", "to_time_created": "2023-05-01" }, "paging": { "page_size": 5, "page": 1, "order": "ASC", "order_by": "TIME_CREATED" }, "links": [ { "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" ], "notifications": { "return_url": "https://www.example.com/notifications/return", "status_url": "https://www.example.com/notifications/return", "cancel_url": "https://www.example.com/notifications/return" }, "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" }}Get Available Installment Plans POST
Confirm installment plans available Confirm which installments plans are available to the cardholder for a specific transaction. 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.
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.