IBAN Detail API

Description: Retrieve a single IBAN detail record

Production API URL: #/api/iban/detail Sandbox API URL: https://ibantest.yabandpay.com/api/iban/detail

Method: POST

Header:

Authorization: Bearer {api_account_token}
Content-Type: application/json

1. Request Parameters (Top Level)

Field Type Description Required
uid string API account UID (matches iban_api_account.uid) Required
timestamp integer Request timestamp in seconds Required
nonce string Random string to prevent replay attacks Required
sign string Signature Required
data object Query filter set Required

2. data Object (fields may be sent either at top level or inside data)

Parameter Type Description Required
request_id string Client request id, echoed back in response Optional
id integer IBAN record id Required

Permission isolation: you can only query records where api_account_id = current account id, otherwise -3001 IBAN record not found is returned directly (existence is not exposed for non-owned records).

3. Request Example

{
    "uid": "900001",
    "timestamp": 1750000000,
    "nonce": "Qe3CkH2xP8",
    "sign": "A1AC665F9B40F7C51212BCE080F5B987",
    "data": {
        "request_id": "req_20260820_detail_001",
        "id": 1,
        "timezone": "Asia/Shanghai"
    }
}

4. Response Example

Success

{
    "status": true,
    "code": 200,
    "message": "",
    "data": {
        "id": 1,
        "customer_type": "legal_entity",
        "customer_id": "2012345678",
        "holder_name": "Company name",
        "alternative_name": "First_name Last_name",
        "creditor_identifier": "NL00ZZZ123456780000",
        "bic": "YABNNL22",
        "iban": "NL09YABN0192150222",
        "currency": "EUR",
        "balance": "1000.00",
        "access": 1,
        "access_label": "full",
        "status": 1,
        "status_label": "active",
        "remark": "Test remark",
        "api_account_id": 1,
        "created_at": 1784851200,
        "updated_at": 1784851800,
        "request_id": "req_20260820_detail_001"
    }
}

Failure: Record does not exist / not owned by current account

{
    "status": false,
    "code": -3001,
    "message": "IBAN record not found",
    "data": {}
}

Failure: Missing id

{
    "status": false,
    "code": -3002,
    "message": "The given data was invalid.",
    "data": {}
}

results matching ""

    No results matching ""