IBAN Delete API (Soft Delete)

Description: Soft-delete an IBAN record (no physical deletion; deleted_at is set to the current timestamp). The associated pool record inside iban_generated with is_used=1 is also soft-deleted atomically.

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

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 Deletion condition 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 delete records where api_account_id = current account id. Otherwise -3001 IBAN record not found or delete failed is returned (existence is intentionally not exposed to prevent enumeration attacks).

3. Request Example

{
    "uid": "900001",
    "timestamp": 1750000000,
    "nonce": "Qe3CkH2xP8",
    "sign": "A1AC665F9B40F7C51212BCE080F5B987",
    "data": {
        "request_id": "req_20260820_del_001",
        "id": 1
    }
}

4. Response Example

Success

{
    "status": true,
    "code": 200,
    "message": "",
    "data": {
        "id": 1,
        "deleted_at": 1750000005,
        "request_id": "req_20260820_del_001"
    }
}

Failure: Record not found / not owned / already deleted

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

Failure: missing id or id <= 0

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

results matching ""

    No results matching ""