Terms Definition

Initiate Transaction

Initiating a transaction simply indicates running that transaction to start any process.

Note

To commence transaction for native flow, merchant need to first call this API which will return the txn Token which will be used in all the other native APIs.

Fields required for a Safe Transaction

This is the JSON structure of a Safe Transaction. All the ethereum addresses need to be checksummed:

{
  "accountno": "test@gmail.com",
  "amount": 1000,
  "description": "test this endpoint",
  "merchantid": "123456789012345678",
  "tranpin": "12345"
}

{
    "message": "Success",
    "code": "200",
    "data": {
      "ref": "010203040506070809",
      "message": "Great, OTP successfully sent to the registered Email/Phone",
      "email": "test@gmail.com",
      "phone": "07007947364",
      "amount": 1000,
      "name": "CIROMA TESTING",
      "link": null
    },
    "error": null,
    "error_description": null,
    "meta": {}
  }

Sending OTP

Send OTP

A one-time password ( OTP ), also known as a one-time PIN or dynamic password, is a password that is valid for only one login session or transaction, on a computer system or other digital device.

Setting up an OTP API verification provides a business with the secure and safest environment to use mobile phones for shopping, business, financial transactions etc. OTP verification not only provides phone security but also keeps your personal computers or laptops secure.

{
    "ref": "010203040506070809"
  }

{
    "message": "Success",
    "code": "200",
    "data": "Great, OTP successfully sent to the registered Email/Phone",
    "error": null,
    "error_description": null,
    "meta": {}
}

Verifying OTP

Verify OTP

The SMS Verify API delivers phone-based verification and two-factor authentication using a limited duration, one-time passcode sent over SMS

You can either generate the verification code yourself or have TeleSign generate it for you. You can also optionally screen verification SMS recipients by risk score or SIM swap risk indicator. You also have the option to configure your verification codes to expire after a set duration of time or after a max number of attempts by an end user.

Common Use Cases:

Two Factor Authentication (2FA) - Prompt a user, after entering their password, to enter a verification code you send to their phone number to complete a log-in process.
Password Reset - Ask a user to enter a verification code you send to their phone number; if they enter it correctly, allow that user to reset their password.
Login verification - Ensure a user do not enter a fake phone number, by sending a verification code to their phone and asking them to enter it in.
Payment Verification - Verify a payment with Strong Customer Authentication (SCA), as part of compliance with the European Union's Revised Payment Services Directive (PSD2). This use case is relevant to fintechs, open banking solutions, payment service providers (PSP), and e-commerce platforms.

{
    "otp": "789012",
    "reference": "010203040506070809"
  }

{
      "message": "Success",
      "code": "200",
      "data": {
        "status": "Approved",
        "message": "Great, transaction proccesed successfully",
        "ref": "945601618746806272",
        "amount": 1000,
        "charges": 150,
        "trandate": 1645530953408,
        "payer": "CHISOM IJEOMAH",
        "email": "chisomije92@gmail.com",
        "merchant": "Konga Nig Ltd",
        "merchantNumber": "898965953867317248"
      },
      "error": null,
      "error_description": null,
      "meta": {}
    }