Eko Platform Services Logo

    POSTGenerate Add Recipient Bank OTP

    Generate an OTP to register a recipient's bank for a DigiKhata sender.

    POST/customer/payment/ppi-digikhata/sender/{customer_id}/recipient/bank/otp

    Initiates bank registration for a recipient and dispatches an OTP. Returns a beneficiary_id and otp_ref_id to pass into Validate OTP to Add Recipient.

    Path parameters

    customer_idstringRequired

    Sender's 10-digit mobile number.

    example: 8617567988

    Body parameters

    initiator_idstringRequired

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

    example: 9962981729

    user_codestringRequired

    User code of the retailer/agent the service is run for.

    example: 20810200

    client_ref_idstringoptional

    Unique reference id per API call, generated by your system.

    example: REQ-20260101-001

    recipient_idstringRequired

    Recipient ID of the recipient to register a bank for.

    example: 10017740

    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.

      • beneficiary_idstring

        Beneficiary identifier created for the recipient bank.

      • otp_ref_idstring

        OTP session reference — pass to Validate OTP to Add Recipient.