Create a payment link

curl -X POST "https://test-api.kashier.io/v2/payment-link" \  -H "Content-Type: application/json" \  -d '{    "customer": {      "name": "John Doe"    },    "totalAmount": 100,    "description": "",    "isManualCapture": false,    "paymentType": "simple",    "currency": "EGP",    "state": "submitted",    "extraFees": [      {        "name": "VAT",        "flatFee": 0,        "rate": 5      },      {        "name": "annualFee",        "flatFee": 500,        "rate": 0      }    ],    "dueDate": "2030-01-01 00:00:00+00:00",    "isSuspendedPayment": false,    "referenceId": "123ss456"  }'

{  "message": "string",  "data": {    "_id": "string",    "paymentLinkId": "string",    "paymentRequestId": "string",    "merchantId": "string",    "merchantInfo": {      "storeName": "string"    },    "storeName": "string",    "description": "string",    "customerName": "string",    "customer": null,    "currency": "string",    "totalAmount": 0,    "totalAmountWithoutFees": 0,    "availableAmountForRefund": 0,    "paymentType": "string",    "paymentStatus": "string",    "state": "string",    "dueDate": null,    "creationDate": "string",    "referenceId": "string",    "invoiceReferenceId": "string",    "isSuspendedPayment": true,    "isManualCapture": true,    "isDeleted": true,    "isPaymentLink": true,    "isBulkCreated": true,    "extraFees": [      {        "name": "string",        "flatFee": 0,        "rate": 0      }    ],    "invoiceItems": [      {        "description": "string",        "unitPrice": 0,        "quantity": 0,        "subTotal": 0      }    ],    "labels": [      "string"    ],    "transactions": [      {}    ],    "virtualAmount": null,    "virtualCurrency": null,    "virtualExchangeRate": null,    "virtualRateRecordedAt": null  }}

Creates a single payment link for one customer. Set currency to a virtual currency code (USD_VIRTUAL, EUR_VIRTUAL, GBP_VIRTUAL, SAR_VIRTUAL, AED_VIRTUAL) with totalAmount expressed in that currency to collect in a foreign currency while settling in EGP. Currency conversion must be enabled on your account — without it a virtual currency is rejected with a 400 "Currency conversion feature is not enabled."

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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

customer*

The customer the link is for. name is what appears on the payment page; emailAddress / phoneNumber are what createAndSharePaymentLink sends the link to.

totalAmount*number

Total amount of the link, expressed in currency — e.g. 100.00 for an EGP link, or 40 for a USD_VIRTUAL link.

currency*string

Currency the customer pays in, e.g. EGP, or a virtual currency code (USD_VIRTUAL, EUR_VIRTUAL, GBP_VIRTUAL, SAR_VIRTUAL, AED_VIRTUAL) to collect in a foreign currency and settle in EGP.

description*string

Free-text note about the payment.

paymentType*string

Type of payment, e.g. simple for a standard one-time payment.

state*string

State to create the link in, e.g. submitted or draft.

isManualCapture*boolean

Whether the payment must be captured manually (true) or is captured automatically (false).

isSuspendedPayment?boolean

Whether the link is temporarily suspended (true) or active (false).

dueDate?string

Deadline for completing the payment, in ISO 8601 format, e.g. 2030-01-01T00:00:00.000Z.

referenceId?string

Your own unique identifier for tracking this link.

extraFees?array<>

Additional charges applied to the total, such as taxes or service fees.

items?array<>

The products or services included, for an itemized link.

labels?array<string>

Labels to tag the link with.

Authorization

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Create a payment link

Authorization

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

409application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`