KashierDevelopersKashier Developers

Export payment links

curl -X POST "https://test-api.kashier.io/v2/payment-link/export"
{  "message": "Your request is being processed. You will receive an email shortly."}

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.

Authorization

secretKey
Authorization<token>

Merchant secret key used to identify the merchant, obtained from Kashier's dashboard. Pass the raw secret key value in the Authorization header (NOT a "Bearer" token).

In: header

Query Parameters

limit?integer

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

page?integer

Page number to export.

sortBy?string

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

sortType?integer

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

Value in

  • 1
  • -1
paymentType?string

Filter by payment type. Use all for no filtering.

paymentStatus?string

Filter by payment status.

currency?string

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

startDate?string

Start of the creation date range.

endDate?string

End of the creation date range.

endDueDate?string

Latest due date to include.

startAmountRange?string

Minimum total amount. Leave empty for no lower limit.

endAmountRange?string

Maximum total amount. Leave empty for no upper limit.

search?string

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

Response Body

application/json

application/json

application/json

application/json

application/json

POST
/v2/payment-link/export