Payment links

Get all payment links

Retrieves the merchant's payment links. All filters are optional and can be combined; results are paginated. If the currency conversion feature is enabled on your account you can also filter by a virtual currency view code (e.g. USD_VIRTUAL) to list only the links created in that foreign currency.

get/v2/payment-link

Request

  • Base URL: https://test-api.kashier.io
  • URL: https://test-api.kashier.io/v2/payment-link
  • Auth: API key in header Authorization

Query parameters

currencystring

ISO 4217 currency code to filter by (e.g., EGP). Accepts a virtual currency view code (e.g., USD_VIRTUAL) when currency conversion is enabled.

statestring

Payment link state. Example: submitted

paymentStatus'PAID' | 'UNPAID' | 'OVERDUE' | 'EXPIRED'

Payment state.

paymentType'FIXED_AMOUNT' | 'ITEMIZED'

Payment type.

startDueDatestring

Earliest due date to include.

endDueDatestring

Latest due date to include.

startDatestring

Start of the creation date range.

endDatestring

End of the creation date range.

startAmountRangestring

Minimum total amount.

endAmountRangestring

Maximum total amount.

searchstring

Search for a payment link by its id. Example: PL-2348668602

pageinteger

Page number (pagination).

limitinteger

Number of items per page (pagination).

Response

The merchant's payment links plus pagination info. The virtual* fields and exchangeRateServiceAvailable are only meaningful for currency conversion links.

messagestring
exchangeRateServiceAvailableboolean

Changes

No recorded changes to this operation across all 1 revision of this API.