KashierDevelopersKashier Developers
API reference and playgroundPayment links

Get all payment links

curl -X GET "https://test-api.kashier.io/v2/payment-link"
{  "message": "Payment links retrieved successfully",  "data": [    {      "_id": "67a49c89b0d26b00127c934a",      "description": "",      "dueDate": null,      "isSuspendedPayment": false,      "currency": "EGP",      "paymentLinkId": "PL-2348668603",      "isDeleted": false,      "merchantId": "MID-XXXXX-XXX",      "paymentType": "simple",      "totalAmount": 100,      "availableAmountForRefund": 0,      "state": "submitted",      "customerName": "John Doe",      "paymentRequestId": "PR-2348668603",      "creationDate": "2025-02-06 11:27:05.236000+00:00",      "merchantInfo": {        "storeName": "demo"      },      "extraFees": [        {          "name": "VAT",          "flatFee": 0,          "rate": 5        }      ],      "invoiceItems": [],      "paymentStatus": "paid"    },    {      "_id": "67a49c89b0d26b00127c934b",      "description": "",      "dueDate": null,      "isSuspendedPayment": false,      "currency": "EGP",      "paymentLinkId": "PL-2348668604",      "isDeleted": false,      "merchantId": "MID-XXXXX-XXX",      "paymentType": "simple",      "totalAmount": 1900,      "availableAmountForRefund": 0,      "state": "submitted",      "customerName": "Jane Doe",      "paymentRequestId": "PR-2348668604",      "creationDate": "2025-02-06 11:27:05.236000+00:00",      "merchantInfo": {        "storeName": "demo"      },      "extraFees": [],      "invoiceItems": [],      "paymentStatus": "unpaid",      "virtualAmount": 40,      "virtualCurrency": "USD_VIRTUAL",      "virtualExchangeRate": 47.5,      "virtualRateRecordedAt": "2025-02-06 11:27:05.236000+00:00"    }  ],  "pagination": {    "page": 1,    "limit": 10,    "total": 2,    "totalPages": 1  },  "exchangeRateServiceAvailable": true}

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.

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

currency?string

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.

state?string

Payment link state. Example: submitted

paymentStatus?string

Payment state.

Value in

  • "PAID"
  • "UNPAID"
  • "OVERDUE"
  • "EXPIRED"
paymentType?string

Payment type.

Value in

  • "FIXED_AMOUNT"
  • "ITEMIZED"
startDueDate?string

Earliest due date to include.

endDueDate?string

Latest due date to include.

startDate?string

Start of the creation date range.

endDate?string

End of the creation date range.

startAmountRange?string

Minimum total amount.

endAmountRange?string

Maximum total amount.

search?string

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

page?integer

Page number (pagination).

limit?integer

Number of items per page (pagination).

Response Body

application/json

application/json

application/json

application/json

application/json

GET
/v2/payment-link

Import invoices POST

Creates many invoices at once from an uploaded spreadsheet. Each row becomes an invoice; the response reports how many rows were accepted and which ones failed, so you can fix and re-upload just th…

Create a payment link POST

Creates a single payment link for one customer. Set currency to a virtual currency code (USDVIRTUAL, EURVIRTUAL, GBPVIRTUAL, SARVIRTUAL, AEDVIRTUAL) with totalAmount expressed in that currency to c…