IBAN Edit API

Description: Update an IBAN record. Only the fields that are explicitly sent are modified; omitted fields stay unchanged.

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

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 Required
timestamp integer Request timestamp in seconds Required
nonce string Random string Required
sign string Signature Required
data object Update data 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
holder_name string Account holder name. If provided, it must not be blank. Optional
alternative_name string Alias Optional
creditor_identifier string Creditor identifier Optional
access integer Access permission: 0 none, 1 full, 2 inbound, 3 outbound Optional
remark string Remarks Optional
status integer Account status: 0 inactive, 1 active Optional

Note: besides id, all other fields are optional and patch-style updates are applied. Even when no updatable fields are provided, the API still returns 200 with the current full record details.

Permission isolation: you can only edit records where api_account_id = current account id, otherwise -3001 IBAN record not found is returned.

3. Request Example

{
    "uid": "900001",
    "timestamp": 1750000000,
    "nonce": "Qe3CkH2xP8",
    "sign": "A1AC665F9B40F7C51212BCE080F5B987",
    "data": {
        "request_id": "req_20260820_edit_001",
        "id": 1,
        "alternative_name": "New Alias",
        "creditor_identifier": "NL00ZZZ123456780001",
        "access": 3,
        "remark": "Updated remarks",
        "status": 1
    }
}

4. Response Example

Success (returns the updated full record)

{
    "status": true,
    "code": 200,
    "message": "",
    "data": {
        "id": 1,
        "customer_type": "legal_entity",
        "customer_id": "2012345678",
        "holder_name": "Company name",
        "alternative_name": "New Alias",
        "creditor_identifier": "NL00ZZZ123456780001",
        "bic": "YABNNL22",
        "iban": "NL09YABN0192150222",
        "currency": "EUR",
        "balance": "1000.00",
        "access": 3,
        "access_label": "outbound",
        "status": 1,
        "status_label": "active",
        "remark": "Updated remarks",
        "api_account_id": 1,
        "created_at": 1784851200,
        "updated_at": 1784855400,
        "request_id": "req_20260820_edit_001"
    }
}

Failure: Record not found / not owned by current account

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

Failure: Illegal values for access or status

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

Failure: holder_name sent as an empty string

{
    "status": false,
    "code": -3002,
    "message": "holder_name cannot be empty",
    "data": {}
}

results matching ""

    No results matching ""