Check Beneficiary - Singapay PG

Information

Method	Path	Format	Authentication
POST	`/api/v1.0/disbursements/check-beneficiary`	json	OAuth 2.0 with Access Token

Request Details

Headers Structure

Field	Value	Type	Mandatory	Description	Example
X-PARTNER-ID	api_key	Alphanumeric	Mandatory	API key obtained from the merchant dashboard.	b3ed7d4b-a96c-6c08-b3c7-12c3124242d9
Accept	application/json	Alphabetic	Mandatory	Specifies JSON as the expected response format.	application/json
Authorization	Bearer {bearerToken}	Alphanumeric	Mandatory	Bearer token obtained from the get access token endpoint.	Bearer eyJ0eXAiOiJKV1{…}

Body Structure

Field	Type	Mandatory	Length	Description	Example
bank_swift_code	Alphabetic	Mandatory	8	Bank swift code	BRINIDJA
bank_account_number	Numeric	Mandatory	-	Bank account number	374654353

Body Example

{
  "bank_swift_code": "BRINIDJA",
  "bank_account_number": "374654353"
}

Response Details

Response Structure

Field	Type	Mandatory	Length	Description	Example
status	Numeric	Mandatory	3	HTTP Status Code	200
success	Boolean	Mandatory	1	2xx is true. 4xx-500 is false.	true
data	Array Object	Conditional	-	-	-
> status	Alphabetic	Mandatory	-	Description status. Like: valid or invalid	valid

Response Example

Success: Here’s an example of a successful response.

{
  "status": 200,
  "success": true,
  "data": {
    "status": "valid",
    "bank_name": "Bank BRI",
    "bank_account_number": "34574355",
    "bank_account_name": "Adnan Kasim",
    "bank_swift_code": "BRINIDJA",
    "bank_number_code": "002"
  }
}

Error: This is an example of an unsuccessful request.

{
    "status": 401,
    "success": false,
    "error": {
        "code": 401,
        "message": "Unauthorized partner, please sign in"
    }
}

On this page