Sign in
paymentLinks

List payment links

Use this method to return a paginated list of payment links linked to a processing terminal.

Note: If you want to view the details of a specific payment link and you have its paymentLinkId, use our Retrieve Payment Link method.

Use query parameters to filter the list of results that we return, for example, to search for only active links or multi-use links.

Our gateway returns the following information about each payment link in the list:

  • 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.

For each payment link, we also return a paymentLinkId, which you can use for follow-on actions.

get/processing-terminals/{processingTerminalId}/payment-links

Path parameters

processingTerminalIdstring required

Unique identifier that we assigned to the terminal.

Query parameters

merchantReferencestring

Filter results by the unique identifier that the merchant assigned to the payment link.

linkType'multiUse' | 'singleUse'

Filter results by the type of link. Send a value of <code>singleUse</code> or <code>multiUse</code>.

chargeType'preset' | 'prompt'

Filter results by the user that entered the amount. Send one of the following values:

  • <code>prompt</code> - Customer entered the amount.
  • <code>preset</code> - Merchant entered the amount.
status'active' | 'completed' | 'deactivated' | 'expired'

Filter results by the status of the payment link. Send a value of <code>active</code>, <code>completed</code>,<code>deactived</code>, or <code>expired</code>.

recipientNamestring

Filter results by the customer's name.

recipientEmailstring

Filter results by the customer's email address.

createdOnstring date

Filter results by the link's created date. Send a value in YYYY-MM-DD format.

expiresOnstring date

Filter results by the link's expiry date. Send a value in YYYY-MM-DD format.

beforestring

Return the previous page of results before the value that you specify.

You can’t send the before parameter in the same request as the after parameter.

afterstring

Return the next page of results after the value that you specify.

You can’t send the after parameter in the same request as the before parameter.

limitinteger

Limit the maximum number of results that we return for each page.

Headers

Authorizationstring required

Bearer authentication

Response

Successful request. Returns a paginated list of payment links.

limitinteger required

Maximum number of results that we return for each page.

countinteger required

Number of results we returned on this page.

Note: This might not be the total number of results that match your query.

hasMoreboolean required

Indicates whether there is another page of results available.

Changes