VoucherType

VoucherType to be created – a valid voucher type

Type: string

Example Values: Cash

MSISDN

Cellphone number receiving the voucher

Type: string

Example Values: 27820000000

Reference

A unique transaction reference number¹.

¹Reference numbers must be unique identifiers otherwise an error will be returned by the system

Type: string

Example Values: 101

Default is currency of merchant.  ISO 4217 Currency Codes

Type: int

Example Values: ZAR

Metadata

RequestDT

Transaction amount in cents

Example:  2000 (R 20.00)

Authorization: {{accesstoken}}

Content-Type: application/json

{} (Query)

required

Transaction status

Example: 1 for success

Transaction state

Example: 1 for success

Source of the funds – a valid Celbux voucher number.

Example: 225 00000 00000

A unique transaction reference number given by the merchant.

Reference numbers must be unique identifiers otherwise an error will be returned by the system.

Example: 101.

Transaction amount in cents.

Example:  2000 (R 20.00)

The currency of the merchant.

Example:  ZAR (ISO 4217 Currency Codes)

A unique store identifier code.

Example: 1234

Any other detail that the merchant wishes to store on this transaction.

Example: Teller name

TID (Transaction ID) of the executed payment response.

Example: 1234-5678

A unique transaction reference number given by the merchant.

Example: 101.

Transaction execution time.

Example: 2017/08/10 12:00

Transaction state.

Example: Confirmed, Refunded

Transaction status.

Example: 1 for success.

Failure reason if applicable as noted.

Example: Insufficient funds.

Destination of the funds – a valid Celbux bin with mobile number

Example: 225 00000 00000

A unique transaction reference number given by the merchant**

Example: 101

Transaction amount in cents

Example: 2000 (R 20.00)

The currency of the merchant.

Example: ZAR (ISO 4217 Currency Codes)

A unique store identifier code

Example: 1234

Any other detail that the merchant wishes to store on this transaction

Example: Teller name

TID (Transaction ID) of the executed payment response

Example: 1234-5678

A unique transaction reference number given by the merchant

Example: 101

Transaction execution time

Example: 2017/08/10 12:00

Transaction amount in cents

Example: 2000 (R 20.00)

Deposit state

Example: Success, Failed

Deposit status

Example: 1 for success

Failure reason if applicable as noted

Example: Unknown User

Any other detail that the merchant wishes to store on this transaction

Example: Teller name

A unique transaction reference number given by the merchant.

Reference numbers must be unique identifiers otherwise an error will be returned by the system.

Example: 12345

If a reference number is supplied, the reference number of the original transaction must also be supplied.

Either the TID or reference number must be supplied. If a reference number is supplied, the “OldReference” of the original transaction is also required.

Example: 12345

TID (Transaction ID) of the executed payment response.

Either the TID or reference number must be supplied.  If a reference number is supplied, the “OldReference” of the original transaction is also required.

Example: 1234-5678

Enter a -1 to confirm or 0 to reverse

Example: -1 or 0

TID (Transaction ID) of the executed payment response

Example: 1234-5678

A unique transaction reference number given by the merchant

Example: 101

The reference number given to the original transaction

Example: 101

Transaction execution time.

Example: 2017/08/10 12:00

Transaction state.

Example: Confirmed, Refunded

Transaction status.

Example: 1 for success.

Failure reason if applicable as noted

Example: Insufficient funds.

A unique store identifier code.

Example: 123

TID (Transaction ID) of the executed payment response.

Either the TID or reference number must be supplied.  If a reference number is supplied, the “OldReference” of the original transaction is also required.

Example: 1234-5678

Any other detail that the merchant wishes to store on this transaction

Example: Teller name

{

  “TID”: “”,

  “StoreID”: “Celbux”,

  “Metadata”: “{\”ActionID\”: \”b37beb5b-e5d5-495c-8525-90b275ff4310\”}”

}

TID (Transaction ID) of the executed payment response.

Example: 1234-5678

A unique transaction reference number given by the merchant.

Example: 101

Transaction execution time.

Example: 2017/08/10 12:00

Transaction amount in cents.

Example: 2000 (R 20.00)

Transaction state.

Example: Success, Failed

Transaction status.

Example: 1 for success

Failure reason if applicable as notated.

Example: Insufficient funds

{

  “TID”: “9636209172”,

  “Reference”: “”,

  “Created”: “2020/12/01 17:23”,

  “Amount”: “250”,

  “State”: “Success”,

  “Status”: “1”,

  “Error”: “”

}

TID (Transaction ID) of the executed API call

Example: 1234-5678

Transaction state.

Example: Confirmed, Refunded

Transaction status.

Example: 1 for success.

Failure reason if applicable as noted.

Example: Insufficient funds.

{

  “TID”: “9626629171”,

  “State”: “Success”,

  “Status”: “1”,

  “Error”: “”

}

ID Number

RSA ID number 13 digit

OldMSISDN

Old Mobile number

A unique transaction reference number given by the merchant.

Reference numbers must be unique identifiers otherwise an error will be returned by the system.

Example: 101.

NewMSISDN

New Mobile number

Metadata

Any other detail that the merchant wishes to store on this transaction.

Example: Teller name

Authorization: {{bearertoken}}

Content-Type: application/json

{

    “OldMSISDN”: “0648503047”,

    “IDNumber”: “”,

    “NewMSISDN”: “0648503049”,

    “OTP”: “437147”,

    “Reference”: “{{$timestamp}}”,

“Metadata”: “{\”ActionID\”: \”b37beb5b-e5d5-495c-8525-90b275ff4310\”}”

}

TID (Transaction ID) of the executed API call

Example: 1234-5678

A unique transaction reference number given by the merchant.

Example: 101.

Transaction state.

Example: Confirmed, Refunded

Transaction status.

Example: 1 for success.

Failure reason if applicable as noted.

Example: Insufficient funds.

 {

  “TID”: “9630149199”,

  “Reference”: ” 1707385761″,

  “State”: “Success”,

  “Status”: “1”,

  “Error”: “”

}

Security token used for API authentication

Example: Ty574u9vfBnYY54592jfl5474

Unique name of the Bearer Token

Any other detail that the merchant wishes to store on this transaction

Example: Teller name

Authorization: {{bearertoken}}

Content-Type: application/json

{

    “BearerToken”: “jM3hxb7BVaDsl5RqRf8qsSdOPJWKh1PEIcgmAHAbyXg=”,

    “Title”: “Celbux International”,

    “Expiry”: “”, // leave blank for no expiry

    “Metadata”: “{\”ActionID\”: \”b37beb5b-e5d5-495c-8525-90b275ff4310\”}”

}

TID (Transaction ID) of the executed API call

Example: 1234-5678

Transaction state

Example: Success, Failed

Transaction status

Example: 1 for success

Failure reason if applicable as noted

Example: Unknown User

{

  “TID”: “9684409193”,

  “State”: “Success”,

  “Status”: “1”,

  “Error”: “”

}

Security token used for authentication

Example: Ty574u9vfBnYY54592jfl5474

A unique store identifier code

Example: 12345

Voucher prefix number

Example: 355

Any other detail that the merchant wishes to store on this transaction

Example: Teller name

Authorization: {{bearertoken}}

Content-Type: application/json

{

    “BearerToken”: “jM3hxb7BVaDsl5RqRf8qsSdOPJWKh1PEIcgmAHAbyXg=”,

    “StoreID”: “Celbux”,

    “VoucherPrefix”: “335”,

    “Route”: “https://dev1celbux.appspot.com”,

    “Metadata”: “{\”ActionID\”: \”b37beb5b-e5d5-495c-8525-90b275ff4310\”}”

}

TID (Transaction ID) of the executed API call

Example: 1234-5678

Transaction state.

Example: Confirmed, Refunded

Transaction status.

Example: 1 for success.

Failure reason if applicable as noted

Example: Insufficient funds.

  {

  “TID”: “9626629171”,

  “State”: “Confirmed”,

  “Status”: “1”,

  “Error”: “”

}

Security token used for authentication

Example: Ty574u9vfBnYY54592jfl5474

A unique store identifier code

Example: 12345

Any other detail that the merchant wishes to store on this transaction

Example: Teller name

Authorization: {{bearertoken}}

Content-Type: application/json

{

    “BearerToken”: “jM3hxb7BVaDsl5RqRf8qsSdOPJWKh1PEIcgmAHAbyXg=”,

    “Merchant”: “Merchant1”,

    “StoreID”: “Store1”,

“Metadata”: “{\”ActionID\”: \”b37beb5b-e5d5-495c-8525-90b275ff4310\”}”

}

TID (Transaction ID) of the executed API call

Example: 1234-5678

Transaction state.

Example: Confirmed, Refunded

Transaction status.

Example: 1 for success.

Failure reason if applicable as noted

Example: Insufficient funds.

  {

  “TID”: “9626629171”,

  “State”: “Confirmed”,

  “Status”: “1”,

  “Error”: “”

}

The scope of the access request

Example: read, write

Any other detail that the merchant wishes to store on this transaction

Example: Teller name

Authorization: {{bearertoken}}

Content-Type: application/json

{

    “ClientID”: “Client1”,

    “Expiry”: “3600”,

    “Merchant”: “Merchant1”,

    “Scope”: “root:all”,

    “Secret”: “8vxnURAWj0RIbrck6z85DkC8RwtWnmuekFyz18epYRNoiXSpxNh”,

    “Whitelist”: “*”, // comma-delimited list

“Metadata”: “{\”ActionID\”: \”b37beb5b-e5d5-495c-8525-90b275ff4310\”}”

}

TID (Transaction ID) of the executed API call

Example: 1234-5678

Transaction state.

Example: Success, Failed

Transaction status.

Example: 1 for success

Failure reason if applicable as notated.

Example: Insufficient funds

{

  “TID”: “9636209172”,

  “State”: “Success”,

  “Status”: “1”,

  “Error”: “”

}

KYC status

Example: ‘Open’, ‘Blocked’ or ‘Closed’

Any other detail that the merchant wishes to store on this transaction

Example: Teller name

Authorization: {{bearertoken}}

Content-Type: application/json

{

    // User

    “Username”: “Merchant1”,

    “IDNumber”: “”,

    “KYC”: “0”, // ‘0’ (no limits) or ‘1’ (limits)

    “Status”: “Open”, // ‘Open’, ‘Blocked’ or ‘Closed’

    // Personal

    “DisplayName”: “Store Centurion”,

    “FirstName”: “John”,

    “LastName”: “Mercantile”,

    “MSISDN”: “0648503047”,

    “Email”: “john@mercantile.com”,

    “Currency”: “ZAR”,

    // Address

    “HouseNumber”: “101”,

    “StreetName”: “Clark Ave”,

    “Suburb”: “Centurion”,

    “Town”: “Pretoria”,

    “Province”: “Gauteng”,

    // Bank

    “AccountName”: “MR J M”,

    “AccountNumber”: “6288854619854”,

    “AccountType”: “Savings”,

    “BankName”: “FNB”,

    “BranchCode”: “265005”,

    // Commercial

    “Commission”: “3.0”,

    “CommercialRegistrationNumber”: “754189057”,

    “TaxNumber”: “255700077”,

    “Metadata”: “{\”ActionID\”: \”b37beb5b-e5d5-495c-8525-90b275ff4310\”}”

}

TID (Transaction ID) of the executed API call

Example: 1234-5678

A unique transaction reference number given by the merchant.

Example: 101

Transaction state.

Example: Success, Failed

Transaction status.

Example: 1 for success

Failure reason if applicable as notated.

Example: Insufficient funds

{

  “TID”: “9636209172”,

  “Reference”: “1707385761”,

  “Created”: “2020/12/01 17:23”,

  “Amount”: “250”,

  “State”: “Success”,

  “Status”: “1”,

  “Error”: “”

}

Name of the voucher type

Example: Book, Cash

A unique store identifier code – Source of the funds

Example: 12345

Authorization: {{bearertoken}}

Content-Type: application/json

{

  “Amount”: “10000”,

  “Currency”: “ZAR”,

  “MSISDN”: “Merchant1”,

  “StoreID”: “Celbux”,

  “VoucherType”: “Book”,

  “Reference”: “{{$timestamp}}”,

“Metadata”: “{\”ActionID\”: \”b37beb5b-e5d5-495c-8525-90b275ff4310\”}”

}

TID (Transaction ID) of the executed API call

Example: 1234-5678

A valid voucher number

Example: 228 00000 00000

Transaction execution time

Example: 2013/01/01 12:00

Transaction state

Example: Success, failed

Transaction status

Example: 1 for success

{

  “VoucherNo”: “”,

  “Reference”: “1629965167”,

  “Created”: “2021/08/26 08:06”,

  “Amount”: “1000”,

  “State”: “Success”,

  “Status”: “1”,

  “Error”: “”,

  “VID”: “2628857436”,

  “TID”: “9804699185”

}

Controls whether the voucher is relocked automatically on-spend

Example: 1 or empty field

Controls whether new vouchers are locked by default

Example: 1 or empty field

Controls whether new vouchers of this type are accumulated, or created standalone alongside each other

Example: 1 or empty field

Name of the voucher type

Example: Book, Cash

Controls whether the voucher can be settled into the user’s cash balance

Example: 1 or empty field

Amount in cents that it costs to withdraw this voucher as cash

Example: 900

Authorization: {{bearertoken}}

Content-Type: application/json

{

    “AutoLock”: “”,

    “Locked”: “”,

    “PIN”: “”,

    “ThirdParty”:

    “VAccumulate”: “1”,

    “VMetadata”: “Contains![alcohol] Contains[merchant_name]”,

    “VoucherType”: “Book”,

    “VSettle”: “”,

    “WithdrawFee”: “900”,

“Metadata”: “{\”ActionID\”: \”b37beb5b-e5d5-495c-8525-90b275ff4310\”}”

}

TID (Transaction ID) of the executed API call

Example: 1234-5678

Transaction state

Example: Success, failed

Transaction status

Example: 1 for success

{

  “State”: “Success”,

  “Status”: “1”,

  “Error”: “”,

  “TID”: “9804699185”

}

Name of the voucher type

Example: Book, Cash

Authorization: {{bearertoken}}

Content-Type: application/json

{

    “Merchant”: “Merchant1”,

    “VoucherType”: “Flash”,

“Metadata”: “{\”ActionID\”: \”b37beb5b-e5d5-495c-8525-90b275ff4310\”}”

}

TID (Transaction ID) of the executed API call

Example: 1234-5678

{

 “TID”: “9804699185”

 “State”: “Success”,

  “Status”: “1”,

  “Error”: “”,

}

Time from.

Example Values: 2018/01/01 12:00

Time to.

Example Values: 2018/01/02 16:00

Authorization: {{bearertoken}}

Content-Type: application/json

{

    “ActionID”: “user~0648503047”,

    “DateFrom”: “”,

    “DateTo”: “”,

    “Limit”: 0

}

TID (Transaction ID) of the executed API call

Example: 1234-5678

Transaction state

Example: Success, failed

Transaction status

Example: 1 for success

{

 “TID”: “9804699185”,

  “State”: “Success”,

  “Status”: “1”,

  “Error”: “”

  }

Authorization: {{bearertoken}}

Content-Type: application/json

{

    “MSISDNs”: “Merchant1”, // comma-delimited list

    “Communities”: “celbux101”, // comma-delimited list

“Metadata”: “{\”ActionID\”: \”b37beb5b-e5d5-495c-8525-90b275ff4310\”}”

}

TID (Transaction ID) of the executed API call

Example: 1234-5678

Transaction state

Example: Success, failed

Transaction status

Example: 1 for success

{

 “TID”: “9804699185”,

  “State”: “Success”,

  “Status”: “1”,

  “Error”: “”,

  }

MSISDN

string

Customer’s mobile number

IDNumber

string

RSA ID number 13 digit

OTP

string

One Time Pin number

Reference

string

A unique transaction reference number given by the merchant

Metadata

string

Any other detail that the merchant wishes to store on this transaction Example: Teller name

Authorization: {{bearertoken}}

Content-Type: application/json

{

    “MSISDN”: “27648503049”,

    “IDNumber”: “0107255802087”,

    “OTP”: “602734”,

    “Reference”: “{{$timestamp}}”,

    “Metadata”: “{\”ActionID\”: \”b37beb5b-e5d5-495c-8525-90b275ff4310\”}”

}

TID

string

TID (Transaction ID) of the executed API call

Example: 1234-5678

Reference

string

A unique transaction reference number given by the merchant Example: 101

State

string

Transaction state

Example: Success, failed

Status

int

Transaction status

Example: 1 for success

Error

string

Failure reason if applicable as notated Example: Insufficient funds

{

  “TID”: “9804699185”

  “Reference”: “1629965167”,

  “State”: “Success”,

  “Status”: “1”,

  “Error”: “”

  }

Authorization: {{bearertoken}}

Content-Type: application/json

{

    “OldMSISDN”: “0648503047”,

    “IDNumber”: “”,

    “NewMSISDN”: “0648503049”,

    “OTP”: “437147”,

    “Reference”: “{{$timestamp}}”,

“Metadata”: “{\”ActionID\”: \”b37beb5b-e5d5-495c-8525-90b275ff4310\”}”

}

TID (Transaction ID) of the executed API call

Example: 1234-5678

Transaction state

Example: Success, failed

Transaction status

Example: 1 for success

{

  “TID”: “9804699185”

  “Reference”: “1629965167”,

  “State”: “Success”,

  “Status”: “1”,

  “Error”: “”

 }

Name of the voucher type

Example: Book, Cash

Authorization: {{bearertoken}}

Content-Type: application/json

{

    “Merchant”: “Merchant1”,

    “VoucherType”: “Flash”,

“Metadata”: “{\”ActionID\”: \”b37beb5b-e5d5-495c-8525-90b275ff4310\”}”

}

TID (Transaction ID) of the executed API call

Example: 1234-5678

Transaction state

Example: Success, failed

Transaction status

Example: 1 for success

{

  “TID”: “9804699185”,

  “State”: “Success”,

  “Status”: “1”,

  “Error”: “”

 }

TT0,

TT1,

TT2,

TT3,

TT4,

TT5,

TT6,

TT7,

TT8,

TT9,

TT10,

TT11,

TT12,

TT13,

TT14,

TT15,

TT16,

TT17,

TT18,

TT19,

TT20,

TT21,

TT22,

TT23,

TT24,

TT25,

TT26,

TT27,

TT28,

TT29,

TT30,

TT31,

TT32,

TT1000,

TT1100,

TT1200,

TT1300,

TT1400,

TT1500,

TT1600,

TT1700,

TT1800,

TT1900,

TT2000,

TT2001,

TT2002,

TT2003,

TT2004,

TT2005,

TT2006,

TT2007,

TT2008,

TT2009,

TT2010,

TT2011,

TT2012,

TT2013,

TT2014,

TT2015,

TT2016,

TT2017,

TT2018,

TT2019,

TT2020,

TT2021,

TT2022,

TT2023,

TT2024,

TT2025,

TT2026,

TT2027,

TT2028,

TT2029,

TT2030,

TT2031,

TT2032,

TT2033,

TT2034,

TT2035,

TT2036,

TT2037,

TT2038,

TT2039,

TT2040,

TT2041,

TT2042,

TT2043,

TT2044,

TT2045,

TT2046,

TT2047,

TT2048,

TT3000,

TT3001,

TT3002,

TT3003,

TT3004,

TT3005,

TT3006,

TT3007,

TT3008,

TT3009,

TT3010,

TT3011,

TT3012,

TT3013,

TT3014,

TT3015,

TT3016,

TT3017,

TT3018,

TT3019,

TT2049,

Authorization: {{bearertoken}}

Content-Type: application/json

{

    “Actor”: “bearer~{{celbux-bearer-token}}”,

“Metadata”: “{\”ActionID\”: \”b37beb5b-e5d5-495c-8525-90b275ff4310\”}”,

“TT0”: “celbux101”,

    “TT1”: “celbux101”,

    “TT2”: “celbux101”,

    “TT3”: “celbux101”,

    “TT4”: “celbux101”,

    “TT5”: “celbux101”,

    “TT6”: “celbux101”,

    “TT7”: “celbux101”,

    “TT8”: “celbux101”,

    “TT9”: “celbux101”,

    “TT10”: “celbux101”,

    “TT11”: “celbux101”,

    “TT12”: “celbux101”,

    “TT13”: “celbux101”,

    “TT14”: “celbux101”,

    “TT15”: “celbux101”,

    “TT16”: “celbux101”,

    “TT17”: “celbux101”,

    “TT18”: “celbux101”,

    “TT19”: “celbux101”,

    “TT20”: “celbux101”,

    “TT21”: “celbux101”,

    “TT22”: “celbux101”,

    “TT23”: “celbux101”,

    “TT24”: “celbux101”,

    “TT25”: “celbux101”,

    “TT26”: “celbux101”,

    “TT27”: “celbux101”,

    “TT28”: “celbux101”,

    “TT29”: “celbux101”,

    “TT30”: “celbux101”,

    “TT31”: “celbux101”,

    “TT32”: “celbux101”,

    “TT1000”: “celbux101”,

    “TT1100”: “celbux101”,

    “TT1200”: “celbux101”,

    “TT1300”: “celbux101”,

    “TT1400”: “celbux101”,

    “TT1500”: “celbux101”,

    “TT1600”: “celbux101”,

    “TT1700”: “celbux101”,

    “TT1800”: “celbux101”,

    “TT1900”: “celbux101”,

    “TT2000”: “celbux101”,

    “TT2001”: “celbux101”,

    “TT2002”: “celbux101”,

    “TT2003”: “celbux101”,

    “TT2004”: “celbux101”,

    “TT2005”: “celbux101”,

    “TT2006”: “celbux101”,

    “TT2007”: “celbux101”,

    “TT2008”: “celbux101”,

    “TT2009”: “celbux101”,

    “TT2010”: “celbux101”,

    “TT2011”: “celbux101”,

    “TT2012”: “celbux101”,

    “TT2013”: “celbux101”,

    “TT2014”: “celbux101”,

    “TT2015”: “celbux101”,

    “TT2016”: “celbux101”,

    “TT2017”: “celbux101”,

    “TT2018”: “celbux101”,

    “TT2019”: “celbux101”,

    “TT2020”: “celbux101”,

    “TT2021”: “celbux101”,

    “TT2022”: “celbux101”,

    “TT2023”: “celbux101”,

    “TT2024”: “celbux101”,

    “TT2025”: “celbux101”,

    “TT2026”: “celbux101”,

    “TT2027”: “celbux101”,

    “TT2028”: “celbux101”,

    “TT2029”: “celbux101”,

    “TT2030”: “celbux101”,

    “TT2031”: “celbux101”,

    “TT2032”: “celbux101”,

    “TT2033”: “celbux101”,

    “TT2034”: “celbux101”,

    “TT2035”: “celbux101”,

    “TT2036”: “celbux101”,

    “TT2037”: “celbux101”,

    “TT2038”: “celbux101”,

    “TT2039”: “celbux101”,

    “TT2040”: “celbux101”,

    “TT2041”: “celbux101”,

    “TT2042”: “celbux101”,

    “TT2043”: “celbux101”,

    “TT2044”: “celbux101”,

    “TT2045”: “celbux101”,

    “TT2046”: “celbux101”,

    “TT2047”: “celbux101”,

    “TT2048”: “celbux101”,

    “TT3000”: “celbux101”,

    “TT3001”: “celbux101”,

    “TT3002”: “celbux101”,

    “TT3003”: “celbux101”,

    “TT3004”: “celbux101”,

    “TT3005”: “celbux101”,

    “TT3006”: “celbux101”,

    “TT3007”: “celbux101”,

    “TT3008”: “celbux101”,

    “TT3009”: “celbux101”,

    “TT3010”: “celbux101”,

    “TT3011”: “celbux101”,

    “TT3012”: “celbux101”,

    “TT3013”: “celbux101”,

    “TT3014”: “celbux101”,

    “TT3015”: “celbux101”,

    “TT3016”: “celbux101”,

    “TT3017”: “celbux101”,

    “TT3018”: “celbux101”,

    “TT3019”: “celbux101”

}

TID (Transaction ID) of the executed API call

Example: 1234-5678

Transaction state

Example: Success, failed

Transaction status

Example: 1 for success

{

    “TID”: “9804699185”,

    “State”: “Success”,

    “Status”: “1”,

    “Error”: “”

 }

KYC status

Example: ‘Open’, ‘Blocked’ or ‘Closed’

Any other detail that the merchant wishes to store on this transaction

Example: Teller name

Authorization: {{bearertoken}}

Content-Type: application/json

{

    // User

    “Username”: “Merchant1”,

    “IDNumber”: “”,

    “KYC”: “”,

    “Status”: “”,

    // Personal

    “DisplayName”: “”,

    “FirstName”: “”,

    “LastName”: “”,

    “MSISDN”: “”,

    “Email”: “”,

    “Currency”: “”,

    // Address

    “HouseNumber”: “”,

    “StreetName”: “”,

    “Suburb”: “”,

    “Town”: “”,

    “Province”: “”,

    // Bank

    “AccountName”: “”,

    “AccountNumber”: “”,

    “AccountType”: “”,

    “BankName”: “”,

    “BranchCode”: “”,

    // Commercial

    “Commission”: “”,

    “CommercialRegistrationNumber”: “”,

    “TaxNumber”: “”,

“Metadata”: “{\”ActionID\”: \”b37beb5b-e5d5-495c-8525-90b275ff4310\”}”

}

TID (Transaction ID) of the executed API call

Example: 1234-5678

Transaction state

Example: Success, failed

Transaction status

Example: 1 for success

{

  “TID”: “9804699185”,

  “State”: “Success”,

  “Status”: “1”,

  “Error”: “”

 }

Controls whether the voucher is relocked automatically on-spend

Example: 1 or empty field

Controls whether new vouchers are locked by default

Example: 1 or empty field

Controls whether new vouchers of this type are accumulated, or created standalone alongside each other

Example: 1 or empty field

Name of the voucher type

Example: Book, Cash

Controls whether the voucher can be settled into the user’s cash balance

Example: 1 or empty field

Amount in cents that it costs to withdraw this voucher as cash

Example: 900

Authorization: {{bearertoken}}

Content-Type: application/json

{

    “AutoLock”: “”,

    “Locked”: “”,

    “PIN”: “”,

    “ThirdParty”:

    “VAccumulate”: “1”,

    “VMetadata”: “Contains![alcohol] Contains[merchant_name]”,

    “VoucherType”: “Book”,

    “VSettle”: “”,

    “WithdrawFee”: “900”,

“Metadata”: “{\”ActionID\”: \”b37beb5b-e5d5-495c-8525-90b275ff4310\”}”

}

TID (Transaction ID) of the executed API call

Example: 1234-5678

Transaction state

Example: Success, failed

Transaction status

Example: 1 for success

{

  “TID”: “9804699185”,

  “State”: “Success”,

  “Status”: “1”,

  “Error”: “”

 }

Authorization: {{bearertoken}}

Content-Type: application/json

{

    “Actor”: “bearer~{{celbux-bearer-token}}”,

    “Metadata”: “{\”ActionID\”: \”b37beb5b-e5d5-495c-8525-90b275ff4310\”}”

}

TID (Transaction ID) of the executed API call

Example: 1234-5678

{

    “TID”: “38689646”

“TT0”: “celbux101”,

    “TT1”: “celbux101”,

    “TT2”: “celbux101”,

    “TT3”: “celbux101”,

    “TT4”: “celbux101”,

    “TT5”: “celbux101”,

    “TT6”: “celbux101”,

    “TT7”: “celbux101”,

    “TT8”: “celbux101”,

    “TT9”: “celbux101”,

    “TT10”: “celbux101”,

    “TT11”: “celbux101”,

    “TT12”: “celbux101”,

    “TT13”: “celbux101”,

    “TT14”: “celbux101”,

    “TT15”: “celbux101”,

    “TT16”: “celbux101”,

    “TT17”: “celbux101”,

    “TT18”: “celbux101”,

    “TT19”: “celbux101”,

    “TT20”: “celbux101”,

    “TT21”: “celbux101”,

    “TT22”: “celbux101”,

    “TT23”: “celbux101”,

    “TT24”: “celbux101”,

    “TT25”: “celbux101”,

    “TT26”: “celbux101”,

    “TT27”: “celbux101”,

    “TT28”: “celbux101”,

    “TT29”: “celbux101”,

    “TT30”: “celbux101”,

    “TT31”: “celbux101”,

    “TT32”: “celbux101”,

    “TT1000”: “celbux101”,

    “TT1100”: “celbux101”,

    “TT1200”: “celbux101”,

    “TT1300”: “celbux101”,

    “TT1400”: “celbux101”,

    “TT1500”: “celbux101”,

    “TT1600”: “celbux101”,

    “TT1700”: “celbux101”,

    “TT1800”: “celbux101”,

    “TT1900”: “celbux101”,

    “TT2000”: “celbux101”,

    “TT2001”: “celbux101”,

    “TT2002”: “celbux101”,

    “TT2003”: “celbux101”,

    “TT2004”: “celbux101”,

    “TT2005”: “celbux101”,

    “TT2006”: “celbux101”,

    “TT2007”: “celbux101”,

    “TT2008”: “celbux101”,

    “TT2009”: “celbux101”,

    “TT2010”: “celbux101”,

    “TT2011”: “celbux101”,

    “TT2012”: “celbux101”,

    “TT2013”: “celbux101”,

    “TT2014”: “celbux101”,

    “TT2015”: “celbux101”,

    “TT2016”: “celbux101”,

    “TT2017”: “celbux101”,

    “TT2018”: “celbux101”,

    “TT2019”: “celbux101”,

    “TT2020”: “celbux101”,

    “TT2021”: “celbux101”,

    “TT2022”: “celbux101”,

    “TT2023”: “celbux101”,

    “TT2024”: “celbux101”,

    “TT2025”: “celbux101”,

    “TT2026”: “celbux101”,

    “TT2027”: “celbux101”,

    “TT2028”: “celbux101”,

    “TT2029”: “celbux101”,

    “TT2030”: “celbux101”,

    “TT2031”: “celbux101”,

    “TT2032”: “celbux101”,

    “TT2033”: “celbux101”,

    “TT2034”: “celbux101”,

    “TT2035”: “celbux101”,

    “TT2036”: “celbux101”,

    “TT2037”: “celbux101”,

    “TT2038”: “celbux101”,

    “TT2039”: “celbux101”,

    “TT2040”: “celbux101”,

    “TT2041”: “celbux101”,

    “TT2042”: “celbux101”,

    “TT2043”: “celbux101”,

    “TT2044”: “celbux101”,

    “TT2045”: “celbux101”,

    “TT2046”: “celbux101”,

    “TT2047”: “celbux101”,

    “TT2048”: “celbux101”,

    “TT3000”: “celbux101”,

    “TT3001”: “celbux101”,

    “TT3002”: “celbux101”,

    “TT3003”: “celbux101”,

    “TT3004”: “celbux101”,

    “TT3005”: “celbux101”,

    “TT3006”: “celbux101”,

    “TT3007”: “celbux101”,

    “TT3008”: “celbux101”,

    “TT3009”: “celbux101”,

    “TT3010”: “celbux101”,

    “TT3011”: “celbux101”,

    “TT3012”: “celbux101”,

    “TT3013”: “celbux101”,

    “TT3014”: “celbux101”,

    “TT3015”: “celbux101”,

    “TT3016”: “celbux101”,

    “TT3017”: “celbux101”,

    “TT3018”: “celbux101”,

    “TT3019”: “celbux101”

    “State”: “Success”,

    “Status”: “1”,

    “Error”: “”

}

Format used is yyyy/MM/dd HH.mm

Example: 2013/01/01 12:00

Format used is yyyy/MM/dd HH.mm

Example: 2013/01/01 12:00

Any other detail that this transaction needs

Example: Teller name

Authorization: {{bearertoken}}

Content-Type: application/json

{

  “CellPhoneNumber”: “Merchant1”,

  “DateFrom”: “2010/01/01 00:00”,

  “DateTo”: “2039/12/31 00:00”,

  “IDNumber”: “”,

“Metadata”: “{\”ActionID\”: \”b37beb5b-e5d5-495c-8525-90b275ff4310\”}”,

“TransactionType”: “All”

}

List of Transactions

(JSON object per transaction type)

Example: TID, Date, Time, Type, Amount, Fee, Recipient, ReverseID, ConfirmID, State, Reference and Metadata

Transaction state

Example: Success, failed

Transaction status

Example: 1 for success

Failure reason if applicable as notated

Example: Not a valid customer

{

  “TransactionList”: [

    {

      “TID”: “9372539184”,

      “Date”: “2020/05/07”,

      “Time”: “12:52”,

      “Type”: “Voucher”,

      “Amount”: “300”,

      “Fee”: “0”,

      “Recipient”: “27671490778”,

      “ReverseID”: “0”,

      “ConfirmID”: “0”,

      “State”: “Success”,

      “Reference”: “149044227908”,

      “Metadata”: “”

    }

  ],

  “State”: “Success”,

  “Status”: “1”,

  “Error”: “”

}

Security token used for API authentication

Example: Ty574u9vfBnYY54592jfl5474

Any other detail that this transaction needs

Example: Teller name

Authorization: {{bearertoken}}

Content-Type: application/json

{

    “BearerToken”: “jM3hxb7BVaDsl5RqRf8qsSdOPJWKh1PEIcgmAHAbyXg=”,

“Metadata”: “{\”ActionID\”: \”b37beb5b-e5d5-495c-8525-90b275ff4310\”}”

}

List of Stores

Example: StoreID,MEID,Username

TID (Transaction ID) of the executed API call

Example: 1234-5678

Transaction state

Example: Success, failed

Transaction status

Example: 1 for success

Failure reason if applicable as notated

Example: Not a valid customer

{

  “StoreList”: [

    {

      “StoreID”: “9372539184”,

      “MEID”: “27671490778”,

      “Username”: “JP Mark”

      }

  ],

  “TID”: “3456465462”,

  “State”: “Success”,

  “Status”: “1”,

  “Error”: “”

}

Any other detail that this transaction needs

Example: Teller name

Authorization: {{bearertoken}}

Content-Type: application/json

{

    “Merchant”: “Merchant1”,

    “Metadata”: “{\”ActionID\”: \”b37beb5b-e5d5-495c-8525-90b275ff4310\”}”

}

TID (Transaction ID) of the executed API call

Example: 1234-5678

Name of the voucher type

Example: Book, Cash

Transaction state

Example: Success, failed

Transaction status

Example: 1 for success

Failure reason if applicable as notated

Example: Not a valid customer

{

  “TID”: “9372539184”,

  “VoucherTypes”: “Book, Cash”,

  “State”: “Success”,

  “Status”: “1”,

  “Error”: “”

}

Any other detail that this transaction needs

Example: Teller name

Authorization: {{bearertoken}}

Content-Type: application/json

{

    “Username”: “Merchant1”,

    “IDNumber”: “”,

“Metadata”: “{\”ActionID\”: \”b37beb5b-e5d5-495c-8525-90b275ff4310\”}”

}

KYC status

Example: ‘Open’, ‘Blocked’ or ‘Closed’