SchemaPaymentsPayment Links

List payment links

Use this method to retrieve a paginated list of payment links for a processing terminal.

Path parameters

processingTerminalIdstringRequired>=4 characters<=50 characters

Unique identifier that we assigned to the terminal.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

merchantReferencestringOptional>=1 character<=48 characters

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

linkTypeenumOptional

Filter results by the type of link. Send a value of singleUse or multiUse.

Allowed values:
chargeTypeenumOptional

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

  • prompt - Customer entered the amount.
  • preset - Merchant entered the amount.
Allowed values:
statusenumOptional

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

Allowed values:
recipientNamestringOptional>=1 character<=48 characters

Filter results by the customer’s name.

recipientEmailstringOptional>=6 characters<=128 characters

Filter results by the customer’s email address.

createdOnstringOptionalformat: "date"

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

expiresOnstringOptionalformat: "date"

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

beforestringOptional

Points to the resource identifier that you want to receive your results before. Typically, this is the first resource on the previous page.

afterstringOptional

Points to the resource identifier that you want to receive your results after. Typically, this is the last resource on the previous page.

limitintegerOptional<=100Defaults to 10

States the total amount of results the response is limited to.

Response

Successful request. Returns a paginated list of payment links.

datalist of objects

Array of payment links.

countintegerOptional

Number of results that we returned.

hasMorebooleanOptional

Indicates that further results are available.

limitintegerOptional

Maximum number of results that we return for each page.