KashierDevelopersKashier Developers
API reference and playgroundBeneficiaries

Save the uploaded beneficiaries

curl -X GET "https://test-api.kashier.io/v2/parties/save-parties?correlationId=string&type=beneficiary"
{  "body": [    {      "_id": "67bef80abf4f31001203db66",      "type": "beneficiary",      "name": "Jhon Doe",      "phoneNumber": "1555539512",      "countryCode": "+20",      "customerId": "B-1740568586339",      "merchantId": "MID-XXXXX-XXX",      "transferMethod": "bank",      "credentials": {        "bank": {          "recipientFullName": "Jhon Doe",          "bank": "CIB",          "accountNumber": "010001000"        }      },      "labels": [        "vip"      ],      "createdByUserId": "65e88c7d8930c2001f4103a7",      "createdAt": "2025-02-26T11:16:26.775Z",      "updatedAt": "2025-02-26T11:16:26.775Z"    }  ],  "message": "success"}

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

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

correlationId*string

The correlationId returned by the upload step.

type*"beneficiary"

Must be beneficiary.

Value in

  • "beneficiary"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

GET
/v2/parties/save-parties

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…

List all customers GET

Retrieves the merchant's customers. All parameters are optional and can be combined; results are paginated.