Get Beneficiary List

Testing Env

https://api.uat.sokin.com

GET

/beneficiaries

Get list of beneficiaries.

Request

Query Params

Header Params

Responses

🟢200

application/json

Successful Response

Body

🟠400

🟠401

🟠403

🟠404

🟠422

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.uat.sokin.com/beneficiaries?beneficiaryType&limit&page&orderBy&orderWith&filterValue&filterType' \
--header 'x-api-version;'

Response Example

200 - Example 1

{
    "message": "string",
    "data": [
        {
            "id": "string",
            "beneficiaryId": "string",
            "beneficiarySokinCorporateCode": "string",
            "beneficiaryCorporateName": "string",
            "corporateCode": "string",
            "createdAt": "2019-08-24T14:15:22Z",
            "beneficiaryName": "string",
            "beneficiaryType": "string",
            "accountName": "string",
            "accountType": "string",
            "accountNumber": "string",
            "identifierType": "string",
            "identifierCode": "string",
            "addressLineOne": "string",
            "addressLineTwo": "string",
            "addressLineThree": "string",
            "postalCode": "string",
            "city": "string",
            "currencyCode": "string",
            "countryName": "string",
            "countryCode": "string",
            "beneficiaryNameChinese": "string",
            "payeeIdNumber": "string",
            "payeeMobileNumber": "string",
            "bankName": "string",
            "bankNameChinese": "string",
            "province": "string",
            "provinceChinese": "string",
            "cityChinese": "string"
        }
    ],
    "pagination": {
        "nextToken": "string",
        "previousToken": "string",
        "totalItems": 0,
        "hasMore": true
    }
}

Modified at 2025-12-17 17:47:05

Create External Beneficiary

Get Beneficiary Details