KashierDevelopersKashier Developers
API reference and playgroundBeneficiaries

Upload a beneficiaries sheet for review

curl -X POST "https://test-api.kashier.io/v2/parties/import?type=beneficiary"
{  "beneficiaries": [    {      "name": "Jhon Doe",      "phoneNumber": "1555539512",      "emailAddress": "",      "countryCode": "+20",      "preferredCommunicationChannel": "sms",      "method": {        "type": "bank",        "credentials": {          "recipientFullName": "Jhon Doe",          "bank": "CIB",          "accountNumber": "010001000"        }      },      "labels": [        "vip"      ],      "errors": null    },    {      "name": "Jane Doe",      "phoneNumber": "1509876543",      "emailAddress": "",      "countryCode": "+20",      "method": {        "type": "wallet",        "credentials": {}      },      "errors": {        "walletNumber": "is required"      }    }  ],  "correlationId": "48701e20-ffa2-4c33-be5e-fef3dbfaf94a",  "message": "Some beneficiaries were ignored because they are invalid"}

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 is not. If at least one row is valid the response also carries a correlationId, which you pass to Save the uploaded beneficiaries to commit the batch.

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

type*"beneficiary"

Must be beneficiary.

Value in

  • "beneficiary"

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

POST
/v2/parties/import

Update a beneficiary PUT

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…

Save the uploaded beneficiaries GET

Commits a validated import. Rows that failed validation in Upload a beneficiaries sheet for review are not saved.