Loading...
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.
Bearer access token value used to authorize and access the API. Must always begin with the string "Bearer".
The version of the API to execute the request.
Indicates the expected format of the message response.
The start time to search for in a range, using the resource time_created value.
The end time to search for in a range, using the resource time_created value.
A 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.Indicates whether the link can be used once or multiple times
A descriptive name for the link. This will be visible to the customer on the payment page
A detailed description of your link that will be visible to the customer on the payment page.
Merchant defined field to reference the transaction.
The 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 denomiation of the related currency.
The currency of the amount in ISO-4217(alpha-3)
Indicates 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.
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.
The total number of records to return in a single page for a list. page:
The field to order the list by.
The direction of the ordering of the entire list, ASC or DESC