KashierDevelopersKashier Developers
API reference and playgroundBeneficiaries

Get beneficiary details

curl -X GET "https://test-api.kashier.io/v2/parties/string?type=beneficiary"
{  "body": {    "_id": "67ba05fd87c9970012389428",    "type": "beneficiary",    "name": "Jhon Doe",    "phoneNumber": "01555539512",    "countryCode": "+20",    "emailAddress": "",    "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-22T19:14:37.203Z",    "updatedAt": "2025-02-22T19:14:37.203Z"  },  "message": "Customer retrieved successfully"}

Retrieves one saved beneficiary by its _id.

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.

Query Parameters

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/{id}

Add a beneficiary POST

Saves a new beneficiary. Kashier assigns the customerId (a B- prefixed value) and returns the record with the payment method echoed back as transferMethod plus its credentials under credentials.

Delete a beneficiary DELETE

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