KashierDevelopersKashier Developers
API reference and playgroundBeneficiaries

Update a beneficiary

curl -X PUT "https://test-api.kashier.io/v2/parties/string" \  -H "Content-Type: application/json" \  -d '{    "type": "beneficiary",    "name": "Jhon Doe",    "phoneNumber": "01555539512",    "countryCode": "+20",    "emailAddress": "[email protected]",    "method": {      "type": "bank",      "credentials": {        "recipientFullName": "Jhon Doe",        "bank": "CIB",        "accountNumber": "010001000"      }    },    "labels": [      "vip"    ]  }'
{  "body": {    "message": "Customer updated successfully",    "body": {      "_id": "67ba05fd87c9970012389429",      "type": "beneficiary",      "name": "Jhon Doe",      "phoneNumber": "01555539512",      "countryCode": "+20",      "emailAddress": "[email protected]",      "customerId": "B-1740244477202",      "merchantId": "MID-XXXXX-XXX",      "transferMethod": "bank",      "credentials": {        "bank": {          "recipientFullName": "Jhon Doe",          "bank": "CIB",          "accountNumber": "010001000"        }      },      "labels": [        "vip"      ],      "createdByUserId": "612cdca034b3a9001f38879d",      "createdAt": "2025-02-22T17:14:37.203Z",      "updatedAt": "2025-02-26T09:55:34.630Z"    }  },  "message": "success"}

Updates a saved beneficiary. type, name, and method are required on every update, even when their values have not changed — an update that omits method is rejected rather than treated as a partial edit.

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

id*string

The beneficiary's _id.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

The body used to add or update a beneficiary.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

PUT
/v2/parties/{id}

Delete a beneficiary DELETE

Deletes a saved beneficiary. The response echoes back only the identifying fields of the record that was removed.

Upload a beneficiaries sheet for review POST

Uploads an XLSX sheet of beneficiaries and validates it without saving anything. Every row comes back with an errors field — null when the row is valid, or an object of field: reason pairs when it…