KashierDevelopersKashier Developers

Update a payment link

curl -X PUT "https://test-api.kashier.io/v2/payment-link/string" \  -H "Content-Type: application/json" \  -d '{    "paymentLink": {      "customer": {        "name": "John Doe"      },      "totalAmount": 100,      "description": "",      "isManualCapture": false,      "paymentType": "simple",      "currency": "EGP",      "state": "submitted",      "extraFees": [        {          "name": "tax",          "flatFee": 0,          "rate": 5        },        {          "name": "service",          "flatFee": 0,          "rate": 10        }      ]    }  }'
{  "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  }}

Updates an existing payment link. The editable fields are wrapped in a paymentLink object; send the full object you want the link to end up with.

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

Path Parameters

paymentLinkId*string

The payment link identifier. Example: PL-2348668602

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

The editable payment link fields, wrapped in a paymentLink object.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

PUT
/v2/payment-link/{paymentLinkId}