Payment links

Create and share a payment link

Creates a payment link and immediately sends it to the customer, in a single call. The body is the same as createPaymentLink; the customer's email address or phone number determines the channel the link is sent on.

post/v2/payment-link/create-and-share

Request

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

Request body

totalAmountnumber required

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

currencystring required

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.

descriptionstring required

Free-text note about the payment.

paymentTypestring required

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

statestring required

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

isManualCaptureboolean required

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

isSuspendedPaymentboolean

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

dueDatestring

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

referenceIdstring

Your own unique identifier for tracking this link.

labelsstring[]

Labels to tag the link with.

Response

The created payment link, which has also been sent to the customer.

messagestring

Changes

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