NICEPAY API
API Version 2 (V2)

SMS API

6min

To allow use of s, s need to integrate this with . The SMS API is a collection of s that You can use in -sending to your s or other message recipients.



Process Flow


SMS API Flow
SMS API Flow

  1. The registers data.
  2. The sends data using Registration to .
  3.  register data.
  4.  sends data info to NICE .
  5. NICE sends response data to .
  6.  sends data info to s.
  7. NICE SMS will send info to .
  8.  processes Data Status info and stores it in DB.
  9.  sends data s to s.
  10. The sends a request for to .
  11.  sends response info 200 - OK to .



Integration Specification



Term

Description

Specification

Merchant

e-Commerce company or store that uses s.



Merchant Key

Authentication key prepared by

Must secure

MerchantToken

Token from side

Don't create Token from Client side

iMid

 ID



tXid

Transaction ID



smsMsg

Message content

Message Length

 will provide message delivery in one up to 640 characters or 4 messages, with following details:

  • 160 characters = 1 message
  • If it is more than 160 characters, it will be calculated as follows
    • Semua Telecom Operator (Non XL).
      • 161 - 320 characters = 2 messages.
      • 321 - 459 characters = 3 messages.
      • 481 - 640 characters = 4 messages.
    • XL Telecom Operator.
      • 161 - 306 characters = 2 messages.
      • 307 - 459 characters = 3 messages.
      • 460 - 612 characters = 4 messages.



Valid Character

  • Alphabets (lowercase, uppercase)
  • Number
  • Special Characters ! @ $ * ( ) - + & _ = . , : ; / \ ? { } " % (space) (enter)

smsType

To determine type of sent

0 : Normal 1 : Alert 2 : OTP For OTP , guarantees delivery time from company to Telco is under 300 seconds, and OTP will lower when sending time is more than 300 seconds.

Special Character % must follow by a space.



SMS API Types





See also

 Payout (Disbursement) API to learn detail used on .

 FAQ NICEPAY API if you want to find out frequently asked questions related to .