> ## Documentation Index > Fetch the complete documentation index at: https://docs.singapay.id/llms.txt > Use this file to discover all available pages before exploring further. # Check beneficiary > Performs a real-time beneficiary account name inquiry through the payment gateway banking partner. Accepts `bank_code` as either a three-digit national bank code or a bank SWIFT code. Returns validation status and the account holder name when the account is found. See `Response Code` for the full SP000–SP020 reference. ## OpenAPI ````yaml https://payment-b2b.singapay.id/api/docs/merchant-api.json post /api/v2.0/disbursement/check-beneficiary openapi: 3.1.0 info: title: Singa Merchant API description: >- OpenAPI specification for the merchant/partner HTTP API. All routes below are additionally protected by `ip.whitelisted.merchant` — the caller IP must be registered for the credential or merchant. Obtain a JWT using `POST /api/v1.0/access-token/b2b` (Basic auth) or `POST /api/v1.1/access-token/b2b` (X-Signature) before calling secured endpoints. version: 1.0.0 servers: - url: https://sandbox-payment-b2b.singapay.id description: >- API host. Paths include `/api` prefix (see `RouteServiceProvider`). Replace scheme/host with your environment. security: [] tags: - name: Security description: >- Merchant authentication (`OauthMerchantTokenController`). **v1.1** B2B token uses `X-CLIENT-ID`, `X-PARTNER-ID`, and `X-Signature` (no Basic auth). Secured routes also require the issued Bearer JWT plus `X-PARTNER-ID`. - name: Accounts description: >- Account management (`routes/merchantApiRoute.php`, `v1.0`). Path parameter `{id}` is always the account ULID. - name: Balance Inquiry description: >- Merchant and per-account balance inquiry (`BalanceController`, `v1.0`). Path `account_id` is the account ULID. - name: Statements description: >- Per-account statement list and detail (`AccountController::accountStatements`, `accountStatementDetail`, prefix `v1.0/statements`). Flugger responses; detail path param `{statement_id}` maps to `statements.transaction_id`. - name: Payment Link description: >- Payment link CRUD and payment-method catalog (`PaymentLinkApiController`, prefix `v1.0/payment-link-manage`). `account_id` is ULID; `payment_link_id` is numeric `payment_links.id`. - name: Payment Link History description: >- Payment link transaction/history listing and detail (`PaymentLinkApiController`, prefix `v1.0/payment-link-histories`). `history_id` is numeric `payment_link_histories.id`. - name: Virtual Account description: >- Native VA CRUD (`VirtualAccountController`, prefix `v1.0/virtual-accounts`). `account_id` and `virtual_account_id` are ULIDs. - name: VA Transaction description: >- VA money-in transaction listing and detail (`VirtualAccountController`, prefix `v1.0/va-transactions`). - name: QRIS (Money In) description: >- MPM dynamic QRIS list, show, and generate (`QrisMpmDynamicApiController`, prefix `v1.0/qris-dynamic`). - name: QRIS (Money Out) description: >- Issuer MPM decode/inquiry, payment credit (money out), and transaction status (`QrisIssuerMpmController`, `QrisApiV2Controller::checkStatus`, prefix `v2.0/qris`). Related list/detail: `GET /api/v2.0/qris/transaction/...`. - name: E-Wallet (Money In) description: >- E-Wallet Native checkout and transactions (`EwalletNativeApiController`, `EwalletNativeTransactionApiController`, `EwalletNativeV2ApiController`). Paths include `v1.0/ewallet-native`, `v1.0/ewallet-native-transactions`, and `v2.0/ewallet-native`. - name: E-Wallet (Money Out) description: >- E-wallet disbursement / top-up to beneficiary wallets (`EWalletTopUpController`, prefix `v2.0/ewallet`). Responses use the custom **`MerchantV2ApiEnvelope`** with **`MerchantV2ResponseCode`** (SP000–SP020). - name: Card (Money In) description: >- One-time card payment, cancel, and inquiry (`CardPaymentMerchantApiController`, prefix `v2.0/card`). - name: Subscription (Recurring) description: >- Credit-card recurring subscription plans (`SubscriptionPlanApiController`, prefix `v2.0/recurring`). Plan `{id}` is UUID (`sub_plans.id`). - name: Direct Debit description: >- Direct Debit — bind a customer bank account once via hosted webview, then charge it host-to-host (`DirectDebitMerchantController`, prefix `v2.0/direct-debit`). Binding `{binding_id}` and transaction `{transaction_id}` are UUIDs. Responses use the **`MerchantV2ApiEnvelope`** with both standard SP000–SP020 codes and Direct-Debit-specific codes (`SP_DD_*`). The `/charge` endpoint is additionally protected by **`X-Signature`** + **`X-Timestamp`** (`verify.signature-internal`); see operation parameters for the signing scheme. - name: Account Transfer description: >- Move funds between sub-accounts within the same merchant (`AnotherAccountApiController`, prefix `v1.0/account-transfer`). The transfer endpoint requires request signature headers (`verify.signature-internal`). Both accounts must belong to the authenticated merchant and be accessible to the credential. - name: Disbursement (Money Out) description: >- Bank disbursement (`DisbursementController` **v1.0**, `DisbursementV2Controller` **v2.0**). **v1.0** list/show/fee/beneficiary/transfer use Flugg envelopes; v1 inquiry-status uses the **custom v2 envelope** (`MerchantV2ApiEnvelope`, codes **SP000–SP020**). **v2.0** check-beneficiary, transfer, and inquiry-status use the same custom envelope — see component schema **`MerchantV2ResponseCode`** for the full response code table. - name: Cardless Withdrawal description: >- Cardless withdrawal API for initiating ATM cash withdrawals without a physical card. Supports creating withdrawals with OTP generation, listing transaction history, viewing transaction details, canceling pending withdrawals, and deleting canceled records. All endpoints use the `v1.0/cardless-withdrawals` route prefix and the standard success/error response envelope. Path parameter `{id}` refers to the `transaction_id` (platform-assigned business identifier). paths: /api/v2.0/disbursement/check-beneficiary: post: tags: - Disbursement (Money Out) summary: Check beneficiary description: >- Performs a real-time beneficiary account name inquiry through the payment gateway banking partner. Accepts `bank_code` as either a three-digit national bank code or a bank SWIFT code. Returns validation status and the account holder name when the account is found. See `Response Code` for the full SP000–SP020 reference. operationId: disbursementV2CheckBeneficiary requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DisbursementV2CheckBeneficiaryRequestBody' responses: '200': description: >- **SP000** Successfully — beneficiary verified. Merchant action: none required before transfer. content: application/json: schema: $ref: >- #/components/schemas/MerchantV2ApiEnvelopeDisbursementV2CheckBeneficiary example: response_code: SP000 response_message: Successfully data: bank_code: '002' bank_account_number: '12345678' status: valid bank_account_name: JOHN DOE bank_name: BRI '404': description: >- **SP014** Not Found — beneficiary verification failed (`data.status` `invalid`, see `data.message`). **SP011** Beneficiary Vendor Not Active — invalid `bank_code`. Merchant action: none. content: application/json: schema: $ref: >- #/components/schemas/MerchantV2ApiEnvelopeDisbursementV2CheckBeneficiary example: response_code: SP014 response_message: Not Found data: bank_code: '002' bank_account_number: '12345678' status: invalid bank_account_name: '' bank_name: BRI message: Invalid account:Account inactive '422': description: >- **SP018** Validation error — invalid request fields. Merchant action: fix payload and retry. content: application/json: schema: $ref: '#/components/schemas/MerchantV2ApiEnvelopeError' example: response_code: SP018 response_message: Validation error data: bank_code: BRINIDJA bank_account_number: '111' message: >- Validation error `bank_account_number`: `The bank account number field must be between 6 and 30 digits.` '500': description: >- **SP002** General Failure — banking partner unavailable. Merchant action: check inquiry status or retry later. content: application/json: schema: $ref: '#/components/schemas/MerchantV2ApiEnvelopeError' example: response_code: SP002 response_message: General Failure data: message: Internal Server Error security: - BearerAuth: [] PartnerId: [] components: schemas: DisbursementV2CheckBeneficiaryRequestBody: description: Request body for beneficiary account name inquiry (API v2.0). required: - bank_code - bank_account_number properties: bank_code: description: >- Destination bank identifier: a three-digit national bank code (for example `014`) or an eight-character SWIFT code (for example `BRINIDJA`). type: string example: '002' bank_account_number: description: >- Beneficiary account number. Numeric digits only, between 6 and 30 characters. type: string example: '1234567890000' type: object MerchantV2ApiEnvelopeDisbursementV2CheckBeneficiary: description: >- Custom v2 envelope for check beneficiary. `response_code` is `SP000` when valid (HTTP 200) or `SP014` when verification fails (HTTP 404). required: - response_code - response_message - data properties: response_code: $ref: '#/components/schemas/MerchantV2ResponseCode' response_message: $ref: '#/components/schemas/MerchantV2ResponseMessage' data: $ref: '#/components/schemas/DisbursementV2CheckBeneficiaryData' type: object MerchantV2ApiEnvelopeError: description: >- Custom v2 envelope for error outcomes (`response_code` other than `SP000`). required: - response_code - response_message properties: response_code: $ref: '#/components/schemas/MerchantV2ResponseCode' response_message: $ref: '#/components/schemas/MerchantV2ResponseMessage' data: $ref: '#/components/schemas/MerchantV2ApiErrorData' type: object MerchantV2ResponseCode: description: SingaPay custom business response code. type: string example: SP000 MerchantV2ResponseMessage: description: Human-readable label paired with `response_code`. type: string example: Successfully DisbursementV2CheckBeneficiaryData: description: >- `data` for disbursement v2 check beneficiary. Echoes request fields plus inquiry result. properties: bank_code: description: Bank code from the request (national code or SWIFT). type: string example: '002' bank_account_number: description: Account number from the request. type: string example: '12345678' status: description: >- `valid` when the account inquiry succeeded; `invalid` when verification failed. type: string enum: - valid - invalid bank_account_name: description: >- Registered account holder name. Empty string when `status` is `invalid`. type: string example: '' bank_name: description: Destination bank display name. type: string example: BRI message: description: >- Error detail from the banking partner when `status` is `invalid` or on validation errors. type: - string - 'null' example: Invalid account:Account inactive type: object MerchantV2ApiErrorData: description: >- Common `data` shape on error responses. May include request echo fields plus `message`. properties: message: description: >- Error or validation detail (for example upstream bank message or validation summary). type: - string - 'null' example: Validation error details. type: object additionalProperties: true securitySchemes: BearerAuth: type: http description: >- JWT issued by `POST /api/v1.1/access-token/b2b`. Send `Authorization: Bearer `. bearerFormat: JWT scheme: bearer PartnerId: type: apiKey description: Merchant API key (`Credential.api_key`). Required on every request. name: X-PARTNER-ID in: header ````