Eko Platform Services Logo

    POSTGet Refund OTP

    Request the refund OTP for a failed transaction (sent to the customer's mobile).

    POST/customer/payment/refund/{tid}/otp

    For a failed transaction (tx_status 3), an OTP is sent to the customer's mobile. Call this to (re)send it and obtain the otp_ref_id; pass both into Initiate Refund. The OTP cannot be bypassed.

    Path parameters

    tidstringRequired

    Transaction ID from the Initiate Transaction call.

    example: 13192443

    Body parameters

    initiator_idstringRequired

    Registered mobile number of the API user (see Platform Credentials).

    example: 9962981729

    Headers

    developer_keystringRequired

    Static API key issued to your account after KYC.

    secret-keystringRequired

    Dynamic per-request signature: base64(HMAC-SHA256(timestamp, base64(access_key))).

    secret-key-timestampstringRequired

    Current time in milliseconds since UNIX epoch, used to compute secret-key. Must match server time.

    content-typestringRequired

    application/json

    example: application/json

    Responses

    • statusnumber

      Primary success indicator (0 = success).

    • messagestring

      Human-readable response / error message.

    • response_status_idnumber

      Granular status id; see the shared error-codes table.

    • response_type_idnumber

      A unique id for every possible response shape (success or error) — useful for client logic branching and analytics.

    • dataobject

      API-specific response payload.

      • otp_ref_idstring

        OTP session reference — pass to Initiate Refund.