Payment links

Export payment links

Exports the payment links matching the given filters. The export is generated asynchronously and delivered to the merchant account's email address, so the response only acknowledges that the request is being processed.

post/v2/payment-link/export

Request

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

Query parameters

limitinteger

Number of records per page in the export (e.g., 20).

pageinteger

Page number to export.

sortBystring

Field to sort the export by (e.g., creation date, amount).

sortType1 | -1

Sorting direction: 1 = ascending, -1 = descending.

paymentTypestring

Filter by payment type. Use all for no filtering.

paymentStatusstring

Filter by payment status.

currencystring

ISO 4217 currency code, or a virtual currency view code.

startDatestring

Start of the creation date range.

endDatestring

End of the creation date range.

endDueDatestring

Latest due date to include.

startAmountRangestring

Minimum total amount. Leave empty for no lower limit.

endAmountRangestring

Maximum total amount. Leave empty for no upper limit.

searchstring

Search keyword (e.g., customer name, reference id).

Response

Export accepted for processing — an email with the export follows shortly.

messagestring

Changes

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