{"id":363,"date":"2022-10-26T14:59:35","date_gmt":"2022-10-26T14:59:35","guid":{"rendered":"https:\/\/yournewsite.cardboardstory.com\/?page_id=363"},"modified":"2024-02-21T08:03:31","modified_gmt":"2024-02-21T08:03:31","slug":"api-documentation","status":"publish","type":"page","link":"https:\/\/yournewsite.cardboardstory.com\/","title":{"rendered":"API Documentation"},"content":{"rendered":"

[et_pb_section fb_built=”1″ admin_label=”Hero” _builder_version=”4.20.0″ background_color=”#0d312b” background_enable_image=”off” background_blend=”overlay” custom_padding=”10%|0px|5%|0px” animation_style=”zoom” animation_direction=”bottom” animation_intensity_zoom=”8%” animation_starting_opacity=”100%” global_colors_info=”{}”][et_pb_row _builder_version=”4.16″ background_size=”initial” background_position=”top_left” background_repeat=”repeat” global_colors_info=”{}”][et_pb_column type=”4_4″ _builder_version=”4.16″ custom_padding=”|||” global_colors_info=”{}” custom_padding__hover=”|||”][et_pb_text _builder_version=”4.20.0″ text_font=”Nunito Sans||||||||” text_text_color=”#ffffff” text_font_size=”18px” text_line_height=”1.8em” header_font=”Nunito Sans|700|||||||” header_font_size=”45px” header_line_height=”1.3em” header_2_font=”||||||||” text_orientation=”center” background_layout=”dark” max_width=”700px” module_alignment=”center” global_colors_info=”{}”]<\/p>\n

\"\"<\/h1>\n

OAuth 2.0 API<\/h1>\n

Merchant API<\/h1>\n

Administrative API<\/h1>\n

Integration Specification<\/strong><\/p>\n

[\/et_pb_text][\/et_pb_column][\/et_pb_row][\/et_pb_section][et_pb_section fb_built=”1″ admin_label=”Developer Documentation Section” _builder_version=”4.16″ background_color=”#f8fbfe” custom_padding=”6px|0px|100px|0px||” global_colors_info=”{}”][et_pb_row column_structure=”1_4,3_4″ use_custom_gutter=”on” gutter_width=”2″ _builder_version=”4.20.0″ custom_padding=”87px|||||” global_colors_info=”{}”][et_pb_column type=”1_4″ _builder_version=”4.16″ background_color_gradient_direction=”243deg” background_color_gradient_start=”#3D72E7″ background_color_gradient_end=”#53a0fe” custom_padding=”|||” global_colors_info=”{}” custom_padding__hover=”|||”][et_pb_accordion closed_toggle_background_color=”#ededed” _builder_version=”4.20.0″ _module_preset=”default” toggle_font=”|700|||||||” hover_enabled=”0″ border_radii=”on|21px|21px|21px|21px” global_colors_info=”{}” sticky_enabled=”0″][et_pb_accordion_item title=”Celbux API Call Structure” open=”off” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}”]Celbux API Call Structure<\/a><\/strong><\/span><\/p>\n

Type<\/span><\/p>\n

Resource URL<\/span><\/p>\n

Request<\/span><\/p>\n

Response<\/span>[\/et_pb_accordion_item][et_pb_accordion_item title=”OAUTH 2.0 API ” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]\u00a0OAuth 2.0 API Integration Information – Important<\/strong><\/span><\/a><\/p>\n

Introduction<\/p>\n

1- Environments<\/a><\/strong><\/span><\/p>\n

Please note<\/p>\n

2- createUserVoucher<\/a><\/strong><\/span><\/p>\n

Description<\/p>\n

Resource URL<\/p>\n

createUserVoucherRequest<\/p>\n

Request Header<\/p>\n

Request Body<\/p>\n

createUserVoucherResponse<\/p>\n

Response Body<\/p>\n

3 –<\/a>eftOut<\/a><\/strong><\/span><\/p>\n

Description<\/p>\n

Resource URL<\/p>\n

eftOutRequest<\/p>\n

Request Header<\/p>\n

Request Body<\/p>\n

eftOut Response<\/p>\n

Response Body<\/p>\n

4- listUserVouchers<\/a><\/strong><\/span><\/p>\n

Description<\/p>\n

Resource URL<\/p>\n

Parameters<\/p>\n

listUserVouchersRequest<\/p>\n

Request Header<\/p>\n

Request Body<\/p>\n

listUserVouchersResponse<\/p>\n

Response Body<\/p>\n

5 – settleUserVoucher<\/a><\/strong><\/span><\/p>\n

Description<\/p>\n

Resource URL<\/p>\n

settleUserVoucherRequest<\/p>\n

Request Header<\/p>\n

Request Body<\/p>\n

settleUserVoucherResponse<\/p>\n

Response Body<\/p>\n

6 – transferToUser<\/a><\/strong><\/span><\/p>\n

Description<\/p>\n

Resource URL<\/p>\n

transfertoUserRequest<\/p>\n

Request Header<\/p>\n

Request Body<\/p>\n

transfertoUserResponse<\/p>\n

Response Body<\/p>\n

7 – viewUserBalance<\/a><\/strong><\/span><\/p>\n

Description<\/p>\n

Resource URL<\/p>\n

ViewUserBalanceRequest<\/p>\n

Request Header<\/p>\n

Request Body<\/p>\n

viewUserBalanceResponse<\/p>\n

Response Body<\/p>\n

8 – viewUserTransactions<\/a><\/strong><\/span><\/p>\n

Description<\/p>\n

Resource URL<\/p>\n

viewUserTransactionsRequest<\/p>\n

Request Header<\/p>\n

Request Body<\/p>\n

viewUserTransactionsResponse<\/p>\n

Response Body[\/et_pb_accordion_item][et_pb_accordion_item title=”MERCHANT API” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]Introduction<\/b><\/span><\/a><\/p>\n

Environments<\/strong><\/span><\/a><\/p>\n

Basic Transactions<\/b><\/span><\/a><\/p>\n

1 – Pay<\/b><\/span><\/a><\/p>\n

Description<\/p>\n

Resource URL<\/p>\n

PayRequest<\/p>\n

Request Header<\/p>\n

Request Body<\/p>\n

PayResponse<\/p>\n

Response Body<\/p>\n

2 – Withdraw<\/b><\/span><\/a><\/p>\n

Description<\/p>\n

Resource URL<\/p>\n

Request Header<\/p>\n

Request Body<\/p>\n

WithdrawResponse<\/p>\n

Response Body<\/p>\n

3 – Deposit<\/b><\/span><\/a><\/p>\n

Resource URL<\/p>\n

DepositRequest<\/p>\n

Request Header<\/p>\n

Request Body<\/p>\n

DepositResponse<\/p>\n

Response Body<\/p>\n

4 – Confirm<\/b><\/span><\/a><\/p>\n

Description<\/p>\n

Resource URL<\/p>\n

ConfirmRequest<\/p>\n

Request Header<\/p>\n

Request Body<\/p>\n

ConfirmResponse<\/p>\n

Response Body<\/p>\n

5 – Payment<\/b><\/span><\/a><\/p>\n

Description<\/p>\n

Resource URL<\/p>\n

PaymentRequest<\/p>\n

Request Body<\/p>\n

PaymentResponse<\/p>\n

Response Body[\/et_pb_accordion_item][et_pb_accordion_item title=”ADMINISTRATIVE API” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]Administrative API Integration<\/strong><\/a><\/span><\/p>\n

Introduction<\/span><\/p>\n

Environment<\/strong><\/a><\/span><\/p>\n

Environment<\/p>\n

Simulation Environment<\/p>\n

1 – Add Users to Communities<\/a><\/strong><\/span><\/p>\n

Description<\/p>\n

Resource URL<\/p>\n

addUsersToCommunities Request<\/p>\n

Request Header<\/p>\n

Request Body<\/p>\n

addUsersToCommunities Response<\/p>\n

Response Body<\/p>\n

2 – Change MSISDN<\/a><\/span><\/strong><\/p>\n

Description<\/p>\n

Resource URL<\/p>\n

changeMSISDN Request<\/p>\n

Request Header<\/p>\n

Request Body<\/p>\n

changeMSISDN Response<\/p>\n

Response Body<\/p>\n

3 – Create Bearer Token<\/strong><\/span><\/a><\/p>\n

Description<\/p>\n

Resource URL<\/p>\n

createBearerToken Request<\/p>\n

Request Header<\/p>\n

Request Body<\/p>\n

createBearerToken Response<\/p>\n

Response Body<\/p>\n

4 – Create Merchant Route<\/strong><\/span><\/a><\/p>\n

Description<\/p>\n

Resource URL<\/p>\n

createMerchantRoute Request<\/p>\n

Request Header<\/p>\n

Request Body<\/p>\n

createMerchantRoute Response<\/p>\n

Response Body<\/p>\n

5 – Create Merchant Store<\/strong><\/span><\/a><\/p>\n

Description<\/p>\n

Resource URL<\/p>\n

createMerchantStore Request<\/p>\n

Request Header<\/p>\n

Request Body<\/p>\n

createMerchantStore Response<\/p>\n

Response Body<\/p>\n

6 – Create OAuth Client<\/strong><\/span><\/a><\/p>\n

Description<\/p>\n

Resource URL<\/p>\n

createOAuthClient Request<\/p>\n

Request Header<\/p>\n

Request Body<\/p>\n

createOAuthClient Response<\/p>\n

Response Body<\/p>\n

7 – Create User<\/strong><\/a><\/span><\/p>\n

Description<\/p>\n

Resource URL<\/p>\n

createUser Request<\/p>\n

Request Header<\/p>\n

Request Body<\/p>\n

createUser Response<\/p>\n

Response Body<\/p>\n

8 – Create Voucher<\/a><\/strong><\/span><\/p>\n

Description<\/p>\n

Resource URL<\/p>\n

CreateVoucherRequest<\/p>\n

Request Header<\/p>\n

Request Body<\/p>\n

CreateVoucher Response<\/p>\n

Response Body<\/p>\n

9 – Create Voucher Type<\/strong><\/a><\/span><\/p>\n

Description<\/p>\n

Resource URL<\/p>\n

CreateVoucherType Request<\/p>\n

Request Header<\/p>\n

Request Body<\/p>\n

CreateVoucherType Response<\/p>\n

Response Body<\/p>\n

10 – Link Merchant<\/a><\/strong><\/span><\/p>\n

Description<\/p>\n

Resource URL<\/p>\n

linkMerchant Request<\/p>\n

Request Header<\/p>\n

Request Body<\/p>\n

LinkMerchant Response<\/p>\n

Response Body<\/p>\n

11 – Read Action History<\/a><\/strong><\/span><\/p>\n

Description<\/p>\n

Resource URL<\/p>\n

actionhistory\/read Request<\/p>\n

Request Header<\/p>\n

Request Body<\/p>\n

actionhistory\/read Response<\/p>\n

Response Body<\/p>\n

12 – Remove Users from Communities<\/a><\/strong><\/span><\/p>\n

Description<\/p>\n

Resource URL<\/p>\n

removeUsersFromCommunities Request<\/p>\n

Request Header<\/p>\n

Request Body<\/p>\n

removeUsersFromCommunities Response<\/p>\n

Response Body<\/p>\n

13 – Reset Password<\/strong><\/span><\/a><\/p>\n

Description<\/p>\n

Resource<\/p>\n

ResetPassword Request<\/p>\n

Request Header<\/p>\n

Request Body<\/p>\n

ResetPassword Response<\/p>\n

Response Body<\/p>\n

14 – Send OTP<\/strong><\/span><\/a><\/p>\n

Description<\/p>\n

Resource URL<\/p>\n

sendOTP Request<\/p>\n

Request Header<\/p>\n

Request Body<\/p>\n

SendOtp Response<\/p>\n

Response Body<\/p>\n

15 – Unlink Merchant<\/a><\/span><\/strong><\/p>\n

Description<\/p>\n

Resource URL<\/p>\n

UnlinkMerchant Request<\/p>\n

Request Header<\/p>\n

Request Body<\/p>\n

linkMerchant Response<\/p>\n

Response Body<\/p>\n

16 – Update Actor Auth<\/strong><\/span><\/a><\/p>\n

Description<\/p>\n

Resource URL<\/p>\n

updateActorAuth Request<\/p>\n

Request Header<\/p>\n

Request Body<\/p>\n

updateActorAuth Response<\/p>\n

Response Body<\/p>\n

17 – Update User<\/strong><\/span><\/a><\/p>\n

Description
\nResource URL<\/p>\n

updateUser Request<\/p>\n

Request Header<\/p>\n

Request Body<\/p>\n

updateUser Response<\/p>\n

Response Body<\/p>\n

18 – Update Voucher Type<\/a><\/strong><\/span><\/p>\n

Description<\/p>\n

Resource URL<\/p>\n

updateVoucherType Request<\/p>\n

Request Header<\/p>\n

Request Body<\/p>\n

updateVoucherType Response<\/p>\n

Response Body<\/p>\n

19 – View Actor Auth<\/a><\/strong><\/span><\/p>\n

Description<\/p>\n

Resource URL<\/p>\n

viewActorAuth Request<\/p>\n

Request Header<\/p>\n

Request Body<\/p>\n

viewActorAuth Response<\/p>\n

Response Body<\/p>\n

20 – View Customer Transactions <\/a><\/strong><\/span><\/p>\n

Description<\/p>\n

Resource URL<\/p>\n

viewCustomerTransactions1 Request<\/p>\n

Request Header<\/p>\n

Request Body<\/p>\n

viewCustomerTransactions1 Response<\/p>\n

Response Body<\/p>\n

21 – View Merchant Stores<\/span> <\/a><\/strong><\/p>\n

Description<\/p>\n

Resource URL<\/p>\n

viewMerchantStores Request<\/p>\n

Request Header<\/p>\n

Request Body<\/p>\n

viewMerchantStores Response<\/p>\n

Response Body<\/p>\n

22 – View Merchant Voucher Types<\/a><\/strong><\/span><\/p>\n

Description<\/p>\n

Resource URL<\/p>\n

viewMerchantVoucherTypes Request<\/p>\n

Request Header<\/p>\n

Request Body<\/p>\n

viewMerchantVoucherTypes Response<\/p>\n

Response Body<\/p>\n

23 – View Users<\/a><\/strong><\/span><\/p>\n

Description<\/p>\n

Resource URL<\/p>\n

viewUser Request<\/p>\n

Request Header<\/p>\n

Request Body<\/p>\n

viewUser Response<\/p>\n

Response Body<\/p>\n

24 – View User Communities <\/a><\/strong><\/span><\/p>\n

Description<\/p>\n

Resource URL<\/p>\n

viewUserCommunities Request<\/p>\n

Request Header<\/p>\n

Request Body<\/p>\n

viewUserCommunities Response<\/p>\n

Response Body<\/p>\n

25 – View Voucher<\/a><\/strong><\/span><\/p>\n

Description<\/p>\n

Resource URL<\/p>\n

viewVoucher Request<\/p>\n

Request Header<\/p>\n

Request Body<\/p>\n

viewVoucher Response<\/p>\n

Response Body<\/p>\n

26 – View Voucher Type<\/a><\/strong><\/span><\/p>\n

Description<\/p>\n

Resource URL<\/p>\n

viewVoucherType Request<\/p>\n

Request Header<\/p>\n

Request Body<\/p>\n

viewVoucherType Response<\/p>\n

Response Body<\/p>\n

27 – View Voucher Type Merchants<\/a><\/strong><\/span><\/p>\n

Description<\/p>\n

Resource URL<\/p>\n

viewVoucherTypeMerchants Request<\/p>\n

Request Header<\/p>\n

Request Body<\/p>\n

viewVoucherTypeMerchants Response[\/et_pb_accordion_item][et_pb_accordion_item title=”HTTP and API Error Code” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

HTTP and API Error Code<\/a><\/span><\/strong><\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”FAQ” _builder_version=”4.20.0″ _module_preset=”default” hover_enabled=”0″ global_colors_info=”{}” open=”on” sticky_enabled=”0″]Frequently Asked Questions<\/span><\/strong><\/a><\/p>\n

What is a Bearer Token?<\/span><\/p>\n

What is the difference between POST HTTP method and GET HTTP method?<\/span><\/p>\n

What is an MEID?<\/span><\/p>\n

What is a StoreID?<\/span><\/p>\n

Should I use StoreID or MEID?<\/span><\/p>\n

What is a Reference number?<\/span><\/p>\n

What is a TID?<\/span><\/p>\n

What format do I use the voucher number in the API call?<\/span>[\/et_pb_accordion_item][\/et_pb_accordion][\/et_pb_column][et_pb_column type=”3_4″ _builder_version=”4.16″ background_color_gradient_direction=”243deg” background_color_gradient_start=”#3D72E7″ background_color_gradient_end=”#53a0fe” custom_padding=”|||” global_colors_info=”{}” custom_padding__hover=”|||”][et_pb_text module_id=”CelbuxAPICallStructure” _builder_version=”4.20.0″ text_font=”Nunito Sans||||||||” text_text_color=”#959baf” text_font_size=”18px” text_line_height=”1.8em” header_font=”||||||||” header_2_font=”Nunito Sans|700|||||||” header_2_text_color=”#535b7c” header_2_font_size=”35px” header_2_line_height=”1.3em” header_3_font=”Nunito Sans|700|||||||” header_3_text_color=”#535b7c” header_3_font_size=”25px” header_3_line_height=”1.3em” max_width=”700px” module_alignment=”center” global_colors_info=”{}”]<\/p>\n

A) Celbux API Call Structure<\/strong><\/span><\/h1>\n

All the API calls in this document have the following layout:<\/p>\n

[\/et_pb_text][et_pb_accordion open_toggle_background_color=”#ffffff” closed_toggle_background_color=”#ffffff” icon_color=”rgba(83,91,124,0.4)” _builder_version=”4.20.0″ toggle_text_color=”#535b7c” toggle_level=”h3″ toggle_font=”Roboto Mono|700|||||||” toggle_text_align=”left” toggle_font_size=”18px” body_font=”Roboto Mono||||||||” body_text_color=”#989db0″ body_font_size=”13px” custom_margin=”||100px|” custom_padding=”|||” border_radii=”on|4px|4px|4px|4px” border_width_all=”0px” border_color_all=”#d9d9d9″ border_style_all=”solid” box_shadow_style=”preset3″ box_shadow_color=”rgba(34,56,101,0.12)” use_border_color=”on” border_width=”0px” global_colors_info=”{}”][et_pb_accordion_item title=”API Call Structure” open=”on” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}”]<\/p>\n

Type<\/span><\/strong><\/h4>\n

This specifies the REST call type: GET or POST<\/o:p><\/span><\/p>\n

This is the structure of the API call. If this structure is not correct, the call will fail. The {BaseURL} in the call structures need to be replaced by the URL endpoint supplied to you.<\/o:p><\/span><\/p>\n

<\/span><\/p>\n

Resource URL<\/strong><\/h4>\n

This is the structure of the API call. If this structure is not correct, the call will fail. The {BaseURL} in the call structures need to be replaced by the URL endpoint supplied to you.<\/o:p><\/span><\/p>\n

<\/span><\/p>\n

Request<\/strong><\/h4>\n

The detail required in the call body is specified in this section. Any required fields that are left out, or fields that are populated incorrectly, will cause the call to fail.<\/o:p><\/span><\/p>\n

<\/span><\/p>\n

Response<\/strong><\/h4>\n

The response to a call is detailed in this section including fields returned with success or error codes.<\/o:p><\/span><\/p>\n

[\/et_pb_accordion_item][\/et_pb_accordion][et_pb_text module_id=”OAuthAPI” _builder_version=”4.20.0″ text_font=”Nunito Sans||||||||” text_text_color=”#959baf” text_font_size=”18px” text_line_height=”1.8em” header_font=”||||||||” header_2_font=”Nunito Sans|700|||||||” header_2_text_color=”#535b7c” header_2_font_size=”35px” header_2_line_height=”1.3em” header_3_font=”Nunito Sans|700|||||||” header_3_text_color=”#535b7c” header_3_font_size=”25px” header_3_line_height=”1.3em” max_width=”700px” module_alignment=”center” global_colors_info=”{}”]<\/p>\n

B) OAuth 2.0 API Integration Information<\/strong><\/span><\/h1>\n

[\/et_pb_text][et_pb_text _builder_version=”4.20.0″ text_font=”Nunito Sans||||||||” text_text_color=”#959baf” text_font_size=”18px” text_line_height=”1.8em” header_font=”||||||||” header_2_font=”Nunito Sans|700|||||||” header_2_text_color=”#535b7c” header_2_font_size=”35px” header_2_line_height=”1.3em” header_3_font=”Nunito Sans|700|||||||” header_3_text_color=”#535b7c” header_3_font_size=”25px” header_3_line_height=”1.3em” max_width=”700px” module_alignment=”center” custom_padding=”17px|||||” global_colors_info=”{}”]<\/p>\n

\u00a0OAuth 2.0 API Integration Information – Important<\/h3>\n

[\/et_pb_text][et_pb_accordion open_toggle_background_color=”#ffffff” closed_toggle_background_color=”#ffffff” icon_color=”rgba(83,91,124,0.4)” _builder_version=”4.20.0″ toggle_text_color=”#535b7c” toggle_level=”h3″ toggle_font=”Roboto Mono|700|||||||” toggle_text_align=”left” toggle_font_size=”18px” body_font=”Roboto Mono||||||||” body_text_color=”#989db0″ body_font_size=”13px” custom_margin=”||100px|” custom_padding=”|||” border_radii=”on|4px|4px|4px|4px” border_width_all=”0px” border_color_all=”#d9d9d9″ border_style_all=”solid” box_shadow_style=”preset3″ box_shadow_color=”rgba(34,56,101,0.12)” use_border_color=”on” border_width=”0px” global_colors_info=”{}”][et_pb_accordion_item title=”Introduction” open=”on” _builder_version=”4.20.0″ global_colors_info=”{}”]<\/p>\n

The information described in this section is important to note to ensure the success of integration with the OAuth 2.0 Celbux calls.<\/span><\/p>\n

Celbux supports only Authorization code (Grant Type) as their OAuth 2.0 strategy. The API\u2019s published by Celbux are REST API\u2019s that use simple HTTPS calls. <\/span><\/p>\n

A Bearer Token will be allocated for a simulation environment, as well as a the URL specifically set-up for your dedicated use. This Bearer Token should be placed in the header of the REST Call under Authentication.\u00a0 <\/span><\/p>\n

After successful completion of the simulation testing, new credentials will be supplied to you to permit operating in the live environment. <\/span><\/p>\n

By default, all response and request payloads are in JSON format.<\/span><\/p>\n

Celbux uses standard HTTP status codes when returning errors with additional fields in the body for the error name and code.<\/span><\/p>\n

 <\/p>\n

[\/et_pb_accordion_item][\/et_pb_accordion][et_pb_text module_id=”Environments” _builder_version=”4.20.0″ text_font=”Nunito Sans||||||||” text_text_color=”#959baf” text_font_size=”18px” text_line_height=”1.8em” header_font=”||||||||” header_2_font=”Nunito Sans|700|||||||” header_2_text_color=”#535b7c” header_2_font_size=”35px” header_2_line_height=”1.3em” header_3_font=”Nunito Sans|700|||||||” header_3_text_color=”#535b7c” header_3_font_size=”25px” header_3_line_height=”1.3em” max_width=”700px” module_alignment=”center” global_colors_info=”{}”]<\/p>\n

1 – Environments<\/h3>\n

[\/et_pb_text][et_pb_accordion open_toggle_background_color=”#ffffff” closed_toggle_background_color=”#ffffff” icon_color=”rgba(83,91,124,0.4)” _builder_version=”4.20.0″ toggle_text_color=”#535b7c” toggle_level=”h3″ toggle_font=”Roboto Mono|700|||||||” toggle_text_align=”left” toggle_font_size=”18px” body_font=”Roboto Mono||||||||” body_text_color=”#989db0″ body_font_size=”13px” custom_margin=”||100px|” custom_padding=”|||” border_radii=”on|4px|4px|4px|4px” border_width_all=”0px” border_color_all=”#d9d9d9″ border_style_all=”solid” box_shadow_style=”preset3″ box_shadow_color=”rgba(34,56,101,0.12)” use_border_color=”on” border_width=”0px” locked=”off” global_colors_info=”{}”][et_pb_accordion_item title=”Please note” open=”on” _builder_version=”4.20.0″ global_colors_info=”{}”]The environments listed below are for testing purposes only. Production environment details and user credentials will be shared once successful testing cycles have been concluded.<\/p>\n\n\n\n\n\n\n\n\n\n
Base URL<\/span><\/td>\napi-v1-dot-celbuxproducts.appspot.com<\/strong><\/a>\/v1\/evm\/<\/span><\/td>\n<\/tr>\n
Namespace<\/span><\/td>\nevmtest20170504<\/span><\/td>\n<\/tr>\n
OAuth URL<\/span><\/td>\nhttps:\/\/api-v1-dot-celbuxproducts.appspot.com<\/strong><\/a>\/login\/oauth\/authorize?ns=evmtest2017050<\/span>4<\/span><\/td>\n<\/tr>\n
Access Token URL<\/span><\/td>\nhttps:\/\/api-v1-dot-celbuxproducts.appspot.com<\/strong><\/a>\/login\/oauth\/access_token?ns=evmtest2017050<\/span>4<\/span><\/td>\n<\/tr>\n
Client ID:<\/span><\/td>\nEVMUAT<\/span><\/td>\n<\/tr>\n
Client Secret:<\/span><\/td>\n550830b4-46ca-49534-8d55-360cc6f1219c<\/span><\/td>\n<\/tr>\n
Simulation Environment URL<\/span><\/td>\nhttps:\/\/celbuxproducts.appspot.com\/?ns=evmtest20170504<\/strong><\/a><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

A cash voucher can only be used once and then the change will be moved back to your cash balance. A voucher number is valid for one transaction only.[\/et_pb_accordion_item][\/et_pb_accordion][et_pb_text module_id=”createUserVoucher” _builder_version=”4.20.0″ text_font=”Nunito Sans||||||||” text_text_color=”#959baf” text_font_size=”18px” text_line_height=”1.8em” header_font=”||||||||” header_2_font=”Nunito Sans|700|||||||” header_2_text_color=”#535b7c” header_2_font_size=”35px” header_2_line_height=”1.3em” header_3_font=”Nunito Sans|700|||||||” header_3_text_color=”#535b7c” header_3_font_size=”25px” header_3_line_height=”1.3em” max_width=”700px” module_alignment=”center” custom_margin=”||18px|||” custom_padding=”6px|||||” locked=”off” global_colors_info=”{}”]<\/p>\n

2 -createUserVoucher<\/h3>\n

[\/et_pb_text][et_pb_accordion open_toggle_background_color=”#ffffff” closed_toggle_background_color=”#ffffff” icon_color=”rgba(83,91,124,0.4)” _builder_version=”4.20.0″ toggle_text_color=”#535b7c” toggle_level=”h3″ toggle_font=”Roboto Mono|700|||||||” toggle_text_align=”left” toggle_font_size=”18px” body_font=”Roboto Mono||||||||” body_text_color=”#989db0″ body_font_size=”13px” custom_margin=”||100px|” custom_padding=”|||” border_radii=”on|4px|4px|4px|4px” border_width_all=”0px” border_color_all=”#d9d9d9″ border_style_all=”solid” box_shadow_style=”preset3″ box_shadow_color=”rgba(34,56,101,0.12)” use_border_color=”on” border_width=”0px” locked=”off” global_colors_info=”{}”][et_pb_accordion_item title=”Description” open=”on” _builder_version=”4.20.0″ global_colors_info=”{}”]<\/p>\n

Creating a voucher in the users\u2019 wallet by specifying the amount, voucher type and cellphone number.<\/o:p><\/span><\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Resource URL” _builder_version=”4.20.0″ global_colors_info=”{}” open=”off”]<\/p>\n

https:\/\/{BaseURL}\/createUserVoucher?ns={{namespace}}<\/a><\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”createUserVoucherRequest” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n\n\n\n\n\n
Name<\/span><\/td>\nType<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n
\n

VoucherType<\/span><\/p>\n

\u00a0<\/span><\/p>\n<\/td>\n

string<\/span><\/td>\n\n

VoucherType to be created – a valid voucher type<\/span><\/p>\n

\u00a0<\/span><\/p>\n

Type: string<\/span><\/p>\n

Example Values: Cash<\/span><\/p>\n<\/td>\n<\/tr>\n

\n

MSISDN<\/span><\/p>\n

\u00a0<\/span><\/p>\n<\/td>\n

string<\/span><\/td>\n\n

Cellphone number receiving the voucher<\/span><\/p>\n

\u00a0<\/span><\/p>\n

Type: string<\/span><\/p>\n

Example Values: 27820000000<\/span><\/p>\n<\/td>\n<\/tr>\n

\n

Reference<\/span><\/p>\n

\u00a0<\/span><\/p>\n<\/td>\n

string<\/span><\/td>\n\n

A unique transaction reference number1<\/sup>. <\/span><\/p>\n

\u00a0<\/span><\/p>\n

1<\/span><\/sup>Reference numbers must be unique identifiers otherwise an error will be returned by the system<\/span><\/p>\n

\u00a0<\/span><\/p>\n

Type: string<\/span><\/p>\n

Example Values: 101<\/span><\/p>\n<\/td>\n<\/tr>\n

Amount<\/span><\/td>\nint<\/span><\/td>\n\n

Default is currency of merchant.\u00a0 ISO 4217 Currency Codes<\/span><\/p>\n

\u00a0<\/span><\/p>\n

Type: int<\/span><\/p>\n

Example Values: ZAR<\/span><\/p>\n<\/td>\n<\/tr>\n

Currency<\/span><\/td>\nstring<\/span><\/td>\nDefault is currency of merchant. Example: ZAR (ISO 4217 Currency Codes)<\/span><\/td>\n<\/tr>\n
\n

Metadata<\/span><\/p>\n

\u00a0<\/span><\/p>\n<\/td>\n

string<\/span><\/td>\nAny other detail that the merchant wishes to store on this transaction<\/span><\/td>\n<\/tr>\n
\n

RequestDT<\/span><\/p>\n

\u00a0<\/span><\/p>\n<\/td>\n

string<\/span><\/td>\nRequest date time for transaction execution. Example: 2013\/01\/01 12:00<\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Request Header” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

Authorization: {{accesstoken}}<\/span><\/p>\n

Content-Type: application\/json<\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Request Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

{<\/span><\/p>\n

\u00a0 “VoucherType”: “Cash”,<\/span><\/p>\n

\u00a0 “MSISDN”: “0825553356”,<\/span><\/p>\n

\u00a0 “Reference”: “101”,<\/span><\/p>\n

\u00a0 “Amount”: “1”,<\/span><\/p>\n

\u00a0 “Currency”: “ZAR”,<\/span><\/p>\n

\u00a0 “Metadata”: “{“tellerName”:”mike”}”,<\/span><\/p>\n

\u00a0 “RequestDT”: “2013\/01\/01 12:00”<\/span><\/p>\n

}<\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”createUserVoucherResponse” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n\n\n\n\n\n
Name<\/span><\/td>\nType<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n
VoucherNo<\/span><\/td>\nstring<\/span><\/td>\nA valid voucher number. Example:\u00a0 228 00000 00000<\/span><\/td>\n<\/tr>\n
Reference<\/span><\/td>\nstring<\/span><\/td>\nA unique transaction reference number given by the merchant. Example: 101<\/span><\/td>\n<\/tr>\n
Created<\/span><\/td>\nlong<\/span><\/td>\nTransaction execution time. Example: 2013\/01\/01 12:00<\/span><\/td>\n<\/tr>\n
Amount<\/span><\/td>\nint<\/span><\/td>\nTransaction amount in cents. Example:\u00a0 2000 (R 20.00)<\/span><\/td>\n<\/tr>\n
State<\/span><\/td>\nstring<\/span><\/td>\nTransaction state. Example: Success, failed<\/span><\/td>\n<\/tr>\n
Status<\/span><\/td>\nint<\/span><\/td>\nTransaction status. Example: 1 for success<\/td>\n<\/tr>\n
Error<\/span><\/td>\nstring<\/span><\/td>\nFailure reason if applicable as notated. Example: Insufficient funds<\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Response Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

{<\/span><\/p>\n

\u00a0 “VoucherNo”: “228-14608-52650”,<\/span><\/p>\n

\u00a0 “Reference”: “101”,<\/span><\/p>\n

\u00a0 “Created”: “2020\/07\/30 14:43”,<\/span><\/p>\n

\u00a0 “Amount”: “1”,<\/span><\/p>\n

\u00a0 “State”: “Success”,<\/span><\/p>\n

\u00a0 “Status”: “1”,<\/span><\/p>\n

\u00a0 “Error”: “”<\/span><\/p>\n

}<\/p>\n

[\/et_pb_accordion_item][\/et_pb_accordion][et_pb_text module_id=”eftOut” _builder_version=”4.20.0″ text_font=”Nunito Sans||||||||” text_text_color=”#959baf” text_font_size=”18px” text_line_height=”1.8em” header_font=”||||||||” header_2_font=”Nunito Sans|700|||||||” header_2_text_color=”#535b7c” header_2_font_size=”35px” header_2_line_height=”1.3em” header_3_font=”Nunito Sans|700|||||||” header_3_text_color=”#535b7c” header_3_font_size=”25px” header_3_line_height=”1.3em” max_width=”700px” module_alignment=”center” global_colors_info=”{}”]<\/p>\n

3 – eftOut<\/h3>\n

[\/et_pb_text][et_pb_accordion open_toggle_background_color=”#ffffff” closed_toggle_background_color=”#ffffff” icon_color=”rgba(83,91,124,0.4)” _builder_version=”4.20.0″ toggle_text_color=”#535b7c” toggle_level=”h3″ toggle_font=”Roboto Mono|700|||||||” toggle_text_align=”left” toggle_font_size=”18px” body_font=”Roboto Mono||||||||” body_text_color=”#989db0″ body_font_size=”13px” custom_margin=”||100px|” custom_padding=”|||” border_radii=”on|4px|4px|4px|4px” border_width_all=”0px” border_color_all=”#d9d9d9″ border_style_all=”solid” box_shadow_style=”preset3″ box_shadow_color=”rgba(34,56,101,0.12)” use_border_color=”on” border_width=”0px” locked=”off” global_colors_info=”{}”][et_pb_accordion_item title=”Description” open=”on” _builder_version=”4.20.0″ global_colors_info=”{}”]<\/p>\n

Moving money from a user\u2019s Celbux wallet to a bank account outside of the Celbux platform. eftOut is exclusively for use by financial institutions to perform this function.<\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Resource URL” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

https:\/\/{BaseURL}\/eftOut?ns={{namespace}}<\/a><\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”eftOutRequest” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n
Name<\/span><\/td>\nType<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n
Amount<\/span><\/td>\nint<\/span><\/td>\n\n

Transaction amount in cents <\/span><\/p>\n

Example:\u00a0 2000 (R 20.00)<\/span><\/p>\n<\/td>\n<\/tr>\n

Metadata<\/span><\/td>\nstring<\/span><\/td>\nAny other detail that the merchant wishes to store on this transaction<\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Request Header” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

Authorization: {{accesstoken}}<\/span><\/p>\n

Content-Type: application\/json<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

 <\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Request Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

{<\/span><\/p>\n

\u00a0 “Amount”: “1000”,<\/span><\/p>\n

\u00a0 “Metadata”: “{“tellerName”:”mike”}”<\/span><\/p>\n

}<\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”eftOut Response” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n\n\n\n\n\n
Name<\/span><\/td>\nType<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n
TID<\/span><\/td>\nstring<\/span><\/td>\n\n

TID (Transaction ID) of the executed payment response<\/span><\/p>\n

\u00a0<\/span><\/p>\n

Example: 1234-5678<\/span><\/p>\n<\/td>\n<\/tr>\n

Reference<\/span><\/td>\nstring<\/span><\/td>\n\n

A unique transaction reference number given by the merchant **<\/span><\/p>\n

\u00a0<\/span><\/p>\n

Example: 101<\/span><\/p>\n

\u00a0<\/span><\/p>\n

**Reference numbers must be unique identifiers otherwise an error will be returned by the system.<\/span><\/p>\n<\/td>\n<\/tr>\n

Created<\/span><\/td>\nlong<\/span><\/td>\n\n

Payment execution time<\/span><\/p>\n

\u00a0<\/span><\/p>\n

Example: 2013\/01\/01 12:00<\/span><\/p>\n<\/td>\n<\/tr>\n

Amount<\/span><\/td>\nint<\/span><\/td>\n\n

Transaction amount in cents<\/span><\/p>\n

\u00a0<\/span><\/p>\n

Example:\u00a0 2000 (R 20.00)<\/span><\/p>\n<\/td>\n<\/tr>\n

State<\/span><\/td>\nstring<\/span><\/td>\n\n

Payment state<\/span><\/p>\n

\u00a0<\/span><\/p>\n

Example: Success, failed<\/span><\/p>\n<\/td>\n<\/tr>\n

Status<\/span><\/td>\nint<\/span><\/td>\n\n

Payment status<\/p>\n

 <\/p>\n

Example: 1 for success<\/p>\n<\/td>\n<\/tr>\n

Error<\/span><\/td>\nstring<\/span><\/td>\n\n

Failure reason if applicable as notated<\/span><\/p>\n

\u00a0<\/span><\/p>\n

Example: Insufficient funds<\/span><\/p>\n<\/td>\n<\/tr>\n<\/thead>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Response Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

{<\/span><\/p>\n

\u00a0 “TID”: “”,<\/span><\/p>\n

\u00a0 “Reference”: “”,<\/span><\/p>\n

\u00a0 “Created”: “”,<\/span><\/p>\n

\u00a0 “Amount”: “”,<\/span><\/p>\n

\u00a0 “Status”: “”,<\/span><\/p>\n

\u00a0 “State”: “”,<\/span><\/p>\n

\u00a0 “Error”: “”<\/span><\/p>\n

}<\/p>\n

[\/et_pb_accordion_item][\/et_pb_accordion][et_pb_text module_id=”listUserVouchers” _builder_version=”4.20.0″ text_font=”Nunito Sans||||||||” text_text_color=”#959baf” text_font_size=”18px” text_line_height=”1.8em” header_font=”||||||||” header_2_font=”Nunito Sans|700|||||||” header_2_text_color=”#535b7c” header_2_font_size=”35px” header_2_line_height=”1.3em” header_3_font=”Nunito Sans|700|||||||” header_3_text_color=”#535b7c” header_3_font_size=”25px” header_3_line_height=”1.3em” max_width=”700px” module_alignment=”center” global_colors_info=”{}”]<\/p>\n

4 – listUserVouchers<\/h3>\n

[\/et_pb_text][et_pb_accordion open_toggle_background_color=”#ffffff” closed_toggle_background_color=”#ffffff” icon_color=”rgba(83,91,124,0.4)” _builder_version=”4.20.0″ toggle_text_color=”#535b7c” toggle_level=”h3″ toggle_font=”Roboto Mono|700|||||||” toggle_text_align=”left” toggle_font_size=”18px” body_font=”Roboto Mono||||||||” body_text_color=”#989db0″ body_font_size=”13px” custom_margin=”||100px|” custom_padding=”|||” border_radii=”on|4px|4px|4px|4px” border_width_all=”0px” border_color_all=”#d9d9d9″ border_style_all=”solid” box_shadow_style=”preset3″ box_shadow_color=”rgba(34,56,101,0.12)” use_border_color=”on” border_width=”0px” locked=”off” global_colors_info=”{}”][et_pb_accordion_item title=”Description” open=”on” _builder_version=”4.20.0″ global_colors_info=”{}”]<\/p>\n

Providing the user, the ability to list all active vouchers.<\/span><\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Resource URL” _builder_version=”4.20.0″ global_colors_info=”{}” open=”off”]<\/p>\n

https:\/\/{BaseURL}\/listUserVouchers?ns={{namespace}}<\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Parameters” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

{} (Query)<\/span><\/p>\n

required<\/span><\/p>\n<\/td>\n

Type: string<\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”listUserVouchersRequest” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n
Name<\/span><\/td>\nType<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n
Metadata<\/span><\/td>\nstring<\/span><\/td>\nAny other detail that the merchant wishes to store on this transaction<\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Request Header” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

Authorization: {{accesstoken}}<\/span><\/p>\n

Content-Type: application\/json<\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Request Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

{<\/span><\/p>\n

“Metadata”: “{\\”ActionID\\”: \\”b37beb5b-e5d5-495c-8525-90b275ff4310\\”}”<\/p>\n

}<\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”listUserVouchersResponse” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n\n\n\n\n\n
Name<\/span><\/td>\nType<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n
VID<\/span><\/td>\nstring<\/span><\/td>\nVoucher ID. Example: 2628857436<\/span><\/td>\n<\/tr>\n
VoucherNumber<\/span><\/td>\nstring<\/span><\/td>\nValid Voucher number. Example: 225-25286-81028<\/span><\/td>\n<\/tr>\n
VoucherBalance<\/span><\/td>\nint<\/span><\/td>\nVoucher amount in cents. Example:\u00a0 2000 (R 20.00)<\/span><\/td>\n<\/tr>\n
VoucherCurrency<\/span><\/td>\nstring<\/span><\/td>\nDefault is currency of merchant. Example:\u00a0 ZAR (ISO 4217 Currency Codes)<\/span><\/td>\n<\/tr>\n
State<\/span><\/td>\nstring<\/span><\/td>\nTransaction state. Example: Success, failed<\/span><\/td>\n<\/tr>\n
Status<\/span><\/td>\nint<\/span><\/td>\nTransaction status. Example: 1 for success<\/td>\n<\/tr>\n
string<\/span><\/td>\nstring<\/span><\/td>\nFailure reason if applicable as notated. Example: Invalid request<\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Response Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

{<\/span><\/p>\n

\u00a0\u00a0\u00a0 “Vouchers”: [<\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 {<\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 “VID”: “3611717670”,<\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 “VoucherNumber”: “228-67830-31193”,<\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 “VoucherBalance”: “501”,<\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 “VoucherCurrency”: “ZAR1”<\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 },<\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 {<\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 “VID”: “7364978752”,<\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 “VoucherNumber”: “228-79609-01260”,<\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 “VoucherBalance”: “100000”,<\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 “VoucherCurrency”: “ZAR1”<\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 }<\/span><\/p>\n

\u00a0\u00a0\u00a0 ],<\/span><\/p>\n

\u00a0\u00a0\u00a0 “Status”: “Success”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “State”: “1”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “Error”: “”<\/span><\/p>\n

}<\/p>\n

[\/et_pb_accordion_item][\/et_pb_accordion][et_pb_text module_id=”settleUserVoucher” _builder_version=”4.20.0″ text_font=”Nunito Sans||||||||” text_text_color=”#959baf” text_font_size=”18px” text_line_height=”1.8em” header_font=”||||||||” header_2_font=”Nunito Sans|700|||||||” header_2_text_color=”#535b7c” header_2_font_size=”35px” header_2_line_height=”1.3em” header_3_font=”Nunito Sans|700|||||||” header_3_text_color=”#535b7c” header_3_font_size=”25px” header_3_line_height=”1.3em” max_width=”700px” module_alignment=”center” custom_margin=”||21px|||” global_colors_info=”{}”]<\/p>\n

5 – settleUserVoucher<\/h3>\n

[\/et_pb_text][et_pb_accordion open_toggle_background_color=”#ffffff” closed_toggle_background_color=”#ffffff” icon_color=”rgba(83,91,124,0.4)” _builder_version=”4.20.0″ toggle_text_color=”#535b7c” toggle_level=”h3″ toggle_font=”Roboto Mono|700|||||||” toggle_text_align=”left” toggle_font_size=”18px” body_font=”Roboto Mono||||||||” body_text_color=”#989db0″ body_font_size=”13px” custom_margin=”||100px|” custom_padding=”|||” border_radii=”on|4px|4px|4px|4px” border_width_all=”0px” border_color_all=”#d9d9d9″ border_style_all=”solid” box_shadow_style=”preset3″ box_shadow_color=”rgba(34,56,101,0.12)” use_border_color=”on” border_width=”0px” locked=”off” global_colors_info=”{}”][et_pb_accordion_item title=”Description” open=”on” _builder_version=”4.20.0″ global_colors_info=”{}”]<\/p>\n

Providing the user, the ability to cash out an active voucher and move the money back to their cash balance.<\/span><\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Resource URL” _builder_version=”4.20.0″ global_colors_info=”{}” open=”off”]<\/p>\n

https:\/\/{BaseURL}\/settleUserVoucher?ns={{namespace}}<\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”settleUserVoucherRequest” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n\n
Name<\/span><\/td>\nType<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n
VID<\/span><\/td>\nstring<\/span><\/td>\nVoucher ID. Example: 2628857436<\/span><\/td>\n<\/tr>\n
VNO<\/span><\/td>\nstring<\/span><\/td>\nValid Voucher number. Example: 225-25286-81028<\/span><\/td>\n<\/tr>\n
Metadata<\/span><\/td>\nstring<\/span><\/td>\nAny other detail that the merchant wishes to store on this transaction<\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Request Header” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

Authorization: {{accesstoken}}<\/span><\/p>\n

Content-Type: application\/json<\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Request Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

{<\/span><\/p>\n

\u00a0 “VNO”: “225-41759-96100”,<\/span><\/p>\n

\u00a0 “Metadata”: “{\\”activity\\”:\\”walking\\”}”<\/span><\/p>\n

}<\/a><\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”settleUserVoucherResponse” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n\n\n\n
Name<\/span><\/td>\nType<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n<\/thead>\n
TID<\/span><\/td>\nstring<\/span><\/td>\nTID (Transaction ID) of the executed transaction. Example: 12345678<\/span><\/td>\n<\/tr>\n
State<\/span><\/td>\nstring<\/span><\/td>\nTransaction state. Example: Success, failed<\/span><\/td>\n<\/tr>\n
Status<\/span><\/td>\nint<\/span><\/td>\nTransaction status. Example: 1 for success<\/span><\/td>\n<\/tr>\n
Error<\/span><\/td>\nstring<\/span><\/td>\nFailure reason if applicable as notated. Example: Invalid request<\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Response Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

{<\/span><\/p>\n

\u00a0 “TID”: “”,<\/span><\/p>\n

\u00a0 “Status”: “”,<\/span><\/p>\n

\u00a0 “State”: “”,<\/span><\/p>\n

\u00a0 “Error”: “”<\/span><\/p>\n

}<\/p>\n

[\/et_pb_accordion_item][\/et_pb_accordion][et_pb_text module_id=”transferToUser” _builder_version=”4.20.0″ text_font=”Nunito Sans||||||||” text_text_color=”#959baf” text_font_size=”18px” text_line_height=”1.8em” header_font=”||||||||” header_2_font=”Nunito Sans|700|||||||” header_2_text_color=”#535b7c” header_2_font_size=”35px” header_2_line_height=”1.3em” header_3_font=”Nunito Sans|700|||||||” header_3_text_color=”#535b7c” header_3_font_size=”25px” header_3_line_height=”1.3em” max_width=”700px” module_alignment=”center” global_colors_info=”{}”]<\/p>\n

6 – transferToUser<\/h3>\n

[\/et_pb_text][et_pb_accordion open_toggle_background_color=”#ffffff” closed_toggle_background_color=”#ffffff” icon_color=”rgba(83,91,124,0.4)” _builder_version=”4.20.0″ toggle_text_color=”#535b7c” toggle_level=”h3″ toggle_font=”Roboto Mono|700|||||||” toggle_text_align=”left” toggle_font_size=”18px” body_font=”Roboto Mono||||||||” body_text_color=”#989db0″ body_font_size=”13px” custom_margin=”||100px|” custom_padding=”|||” border_radii=”on|4px|4px|4px|4px” border_width_all=”0px” border_color_all=”#d9d9d9″ border_style_all=”solid” box_shadow_style=”preset3″ box_shadow_color=”rgba(34,56,101,0.12)” use_border_color=”on” border_width=”0px” locked=”off” global_colors_info=”{}”][et_pb_accordion_item title=”Description” open=”on” _builder_version=”4.20.0″ global_colors_info=”{}”]<\/p>\n

Sending money from one user to another user using their cell phone number.<\/o:p><\/span><\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Resource URL” _builder_version=”4.20.0″ global_colors_info=”{}” open=”off”]<\/p>\n

https:\/\/{BaseURL}\/transferToUser?ns={{namespace}}<\/a><\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”transfertoUserRequest” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n\n
Name<\/span><\/td>\nType<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n
Amount<\/span><\/td>\nint<\/span><\/td>\nTransaction amount in cents. Example: 2000 (R 20.00)<\/span><\/td>\n<\/tr>\n
UserTo<\/span><\/td>\nstring<\/span><\/td>\nCellphone number receiving the voucher. Example: 27726721229<\/span><\/td>\n<\/tr>\n
Metadata<\/span><\/td>\nstring<\/span><\/td>\nAny other detail that the merchant wishes to store on this transaction<\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Request Header” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

Authorization: {{accesstoken}}<\/span><\/p>\n

Content-Type: application\/json<\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Request Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

{<\/span><\/p>\n

\u00a0 “Amount”: “1”,<\/span><\/p>\n

\u00a0 “UserTo”: “900000101”,<\/span><\/p>\n

\u00a0 “Metadata”: “{\\”tellerName\\”:\\”mike\\”}”<\/span><\/p>\n

}<\/a><\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”transfertoUserResponse” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n\n\n
Name<\/span><\/td>\nType<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n
TID<\/span><\/td>\nstring<\/span><\/td>\nTID (Transaction ID) of the executed transaction. Example: 12345678<\/span><\/td>\n<\/tr>\n
State<\/span><\/td>\nstring<\/span><\/td>\nTransaction state. Example: Success, failed<\/span><\/td>\n<\/tr>\n
Status<\/span><\/td>\nint<\/span><\/td>\nTransaction status. Example: 1 for success<\/span><\/td>\n<\/tr>\n
Error<\/span><\/td>\nstring<\/span><\/td>\nFailure reason if applicable as notated. Example: Insufficient funds<\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Response Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

{<\/span><\/p>\n

\u00a0 “TID”: “9474139171”,<\/span><\/p>\n

\u00a0 “Status”: “Success”,<\/span><\/p>\n

\u00a0 “State”: “1”,<\/span><\/p>\n

\u00a0 “Error”: “”<\/span><\/p>\n

}<\/p>\n

[\/et_pb_accordion_item][\/et_pb_accordion][et_pb_text module_id=”viewUserBalance” _builder_version=”4.20.0″ text_font=”Nunito Sans||||||||” text_text_color=”#959baf” text_font_size=”18px” text_line_height=”1.8em” header_font=”||||||||” header_2_font=”Nunito Sans|700|||||||” header_2_text_color=”#535b7c” header_2_font_size=”35px” header_2_line_height=”1.3em” header_3_font=”Nunito Sans|700|||||||” header_3_text_color=”#535b7c” header_3_font_size=”25px” header_3_line_height=”1.3em” max_width=”700px” module_alignment=”center” global_colors_info=”{}”]<\/p>\n

7 – viewUserBalance<\/h3>\n

[\/et_pb_text][et_pb_accordion open_toggle_background_color=”#ffffff” closed_toggle_background_color=”#ffffff” icon_color=”rgba(83,91,124,0.4)” _builder_version=”4.20.0″ toggle_text_color=”#535b7c” toggle_level=”h3″ toggle_font=”Roboto Mono|700|||||||” toggle_text_align=”left” toggle_font_size=”18px” body_font=”Roboto Mono||||||||” body_text_color=”#989db0″ body_font_size=”13px” custom_margin=”||100px|” custom_padding=”|||” border_radii=”on|4px|4px|4px|4px” border_width_all=”0px” border_color_all=”#d9d9d9″ border_style_all=”solid” box_shadow_style=”preset3″ box_shadow_color=”rgba(34,56,101,0.12)” use_border_color=”on” border_width=”0px” locked=”off” global_colors_info=”{}”][et_pb_accordion_item title=”Description” open=”on” _builder_version=”4.20.0″ global_colors_info=”{}”]<\/p>\n

To view only the user\u2019s cash balance.<\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Resource URL” _builder_version=”4.20.0″ global_colors_info=”{}” open=”off”]<\/p>\n

https:\/\/{BaseURL}\/viewUserBalance?ns={{namespace}}<\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”viewUserBalanceRequest” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n
Name<\/span><\/td>\nType<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n
Metadata<\/span><\/td>\nstring<\/span><\/td>\nAny other detail that the merchant wishes to store on this transaction.<\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Request Header” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

Authorization: {{accesstoken}}<\/span><\/p>\n

Content-Type: application\/json<\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Request Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

{<\/span><\/p>\n

“Metadata”: “{\\”ActionID\\”: \\”b37beb5b-e5d5-495c-8525-90b275ff4310\\”}”<\/p>\n

}<\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”viewUserBalanceResponse” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n\n\n\n\n
Name<\/span><\/td>\nType<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n<\/thead>\n
Balance<\/span><\/td>\nint<\/span><\/td>\nUser\u2019s account balance, amount in cents Example: 2000 (R 20.00)<\/span><\/td>\n<\/tr>\n
Currency<\/span><\/td>\nstring<\/span><\/td>\nDefault is currency of merchant Example: ZAR (ISO 4217 Currency Codes)<\/span><\/td>\n<\/tr>\n
Status<\/span><\/td>\nint<\/span><\/td>\n\n

Transaction status<\/span><\/p>\n

\u00a0<\/span><\/p>\n

Example: 1 for success<\/span><\/p>\n<\/td>\n<\/tr>\n

State<\/span><\/td>\nstring<\/span><\/td>\n\n

Transaction state<\/span><\/p>\n

Example: 1 for success<\/span><\/p>\n<\/td>\n<\/tr>\n

Error<\/span><\/td>\nstring<\/span><\/td>\nFailure reason if applicable as notated Example: Invalid Request<\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Response Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

{<\/span><\/p>\n

\u00a0\u00a0\u00a0 “Balance”: “98496”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “Currency”: “ZAR”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “Status”: “200”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “State”: “Success”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “Error”: “”<\/span><\/p>\n

}<\/p>\n

 <\/p>\n

[\/et_pb_accordion_item][\/et_pb_accordion][et_pb_text module_id=”viewUserTransactions” _builder_version=”4.20.0″ text_font=”Nunito Sans||||||||” text_text_color=”#959baf” text_font_size=”18px” text_line_height=”1.8em” header_font=”||||||||” header_2_font=”Nunito Sans|700|||||||” header_2_text_color=”#535b7c” header_2_font_size=”35px” header_2_line_height=”1.3em” header_3_font=”Nunito Sans|700|||||||” header_3_text_color=”#535b7c” header_3_font_size=”25px” header_3_line_height=”1.3em” max_width=”700px” module_alignment=”center” global_colors_info=”{}”]<\/p>\n

8 – viewUserTransactions<\/h3>\n

[\/et_pb_text][et_pb_accordion open_toggle_background_color=”#ffffff” closed_toggle_background_color=”#ffffff” icon_color=”rgba(83,91,124,0.4)” _builder_version=”4.20.0″ toggle_text_color=”#535b7c” toggle_level=”h3″ toggle_font=”Roboto Mono|700|||||||” toggle_text_align=”left” toggle_font_size=”18px” body_font=”Roboto Mono||||||||” body_text_color=”#989db0″ body_font_size=”13px” custom_margin=”||100px|” custom_padding=”|||” border_radii=”on|4px|4px|4px|4px” border_width_all=”0px” border_color_all=”#d9d9d9″ border_style_all=”solid” box_shadow_style=”preset3″ box_shadow_color=”rgba(34,56,101,0.12)” use_border_color=”on” border_width=”0px” locked=”off” global_colors_info=”{}”][et_pb_accordion_item title=”Description” open=”on” _builder_version=”4.20.0″ global_colors_info=”{}”]<\/p>\n

To return a specified transaction type or all of a users\u2019 transactions within a specified date range.<\/o:p><\/span><\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Resource URL” _builder_version=”4.20.0″ global_colors_info=”{}” open=”off”]<\/p>\n

https:\/\/{BaseURL}\/viewUserTransactions?ns={{namespace}}<\/a><\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”viewUserTransactionsRequest” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n\n\n\n\n
Name<\/span><\/td>\nType<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n
DateFrom<\/span><\/td>\nstring<\/span><\/td>\nTime from Example: 2018\/01\/01 12:00<\/span><\/td>\n<\/tr>\n
DateTo<\/span><\/td>\nstring<\/span><\/td>\nTime to Example: 2018\/01\/02 16:00<\/span><\/td>\n<\/tr>\n
Limit<\/span><\/td>\nint<\/span><\/td>\nAn Integer to limit the quantity of responses. Example: 100<\/span><\/td>\n<\/tr>\n
Metadata<\/span><\/td>\nstring<\/span><\/td>\nAny other detail that the merchant wishes to store on this transaction.<\/span><\/td>\n<\/tr>\n
Offset<\/span><\/td>\nint<\/span><\/td>\nAn Integer to indicate the start index of the list. (Used to return additional records if Limit was used previously) Example: 100<\/span><\/td>\n<\/tr>\n
TransactionType<\/span><\/td>\nstring<\/span><\/td>\nOptions are All, Buy, Cash Out, Change, Commission, Deposit, EFT, EFT Reverse, Pay, Purchase, Receive, Reset, Reverse, Transfer, Voucher, Voucher Merchant or Withdraw<\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Request Header” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

Authorization: {{accesstoken}}<\/span><\/p>\n

Content-Type: application\/json<\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Request Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

{<\/span><\/p>\n

\u00a0 “DateFrom”: “2018\/01\/01 12:00”,<\/span><\/p>\n

\u00a0 “DateTo”: “2018\/07\/01 12:00”,<\/span><\/p>\n

\u00a0 “Limit”: “100”,<\/span><\/p>\n

“Metadata”: “{\\”ActionID\\”: \\”b37beb5b-e5d5-495c-8525-90b275ff4310\\”}”,<\/p>\n

“Offset”: “0”,<\/span><\/p>\n

\u00a0 “TransactionType”: “All”<\/span><\/p>\n

}<\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”viewUserTransactionsResponse” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n\n\n\n\n
Name<\/span><\/td>\nType<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n
TID<\/span><\/td>\nstring<\/span><\/td>\nTID (Transaction ID) of the executed transaction Example: 12345678<\/span><\/td>\n<\/tr>\n
Date<\/span><\/td>\nstring<\/span><\/td>\nTransaction date<\/span><\/td>\n<\/tr>\n
Time<\/span><\/td>\nstring<\/span><\/td>\nTransaction time<\/span><\/td>\n<\/tr>\n
Limit<\/span><\/td>\nint<\/span><\/td>\nAn Integer to limit the quantity of responses. Example: 100<\/span><\/td>\n<\/tr>\n
Offset<\/span><\/td>\nint<\/span><\/td>\nAn Integer to indicate the start index of the list. (Used to return additional records if Limit was used previously) Example: 100<\/span><\/td>\n<\/tr>\n
TransactionType<\/span><\/td>\nstring<\/span><\/td>\nOptions are Trade, Deposit, Withdraw or all<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Response Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

{<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TransactionList”: [],<\/span><\/p>\n

\u00a0\u00a0\u00a0 “State”: “Success”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “Status”: “1”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “Error”: “”<\/span><\/p>\n

}<\/p>\n

[\/et_pb_accordion_item][\/et_pb_accordion][et_pb_text _builder_version=”4.20.0″ text_font=”Nunito Sans||||||||” text_text_color=”#959baf” text_font_size=”18px” text_line_height=”1.8em” header_font=”||||||||” header_2_font=”Nunito Sans|700|||||||” header_2_text_color=”#535b7c” header_2_font_size=”35px” header_2_line_height=”1.3em” header_3_font=”Nunito Sans|700|||||||” header_3_text_color=”#535b7c” header_3_font_size=”25px” header_3_line_height=”1.3em” max_width=”700px” module_alignment=”center” global_colors_info=”{}”][\/et_pb_text][\/et_pb_column][\/et_pb_row][\/et_pb_section][et_pb_section fb_built=”1″ admin_label=”Developer Documentation Section” _builder_version=”4.16″ background_color=”#f8fbfe” custom_padding=”6px|0px|12px|0px||” global_colors_info=”{}”][et_pb_row column_structure=”1_4,3_4″ use_custom_gutter=”on” gutter_width=”2″ _builder_version=”4.20.0″ custom_padding=”87px|||||” global_colors_info=”{}”][et_pb_column type=”1_4″ _builder_version=”4.16″ background_color_gradient_direction=”243deg” background_color_gradient_start=”#3D72E7″ background_color_gradient_end=”#53a0fe” custom_padding=”|||” global_colors_info=”{}” custom_padding__hover=”|||”][\/et_pb_column][et_pb_column type=”3_4″ _builder_version=”4.16″ background_color_gradient_direction=”243deg” background_color_gradient_start=”#3D72E7″ background_color_gradient_end=”#53a0fe” custom_padding=”|||” global_colors_info=”{}” custom_padding__hover=”|||”][et_pb_text module_id=”introductionmerchant” _builder_version=”4.20.0″ text_font=”Nunito Sans||||||||” text_text_color=”#959baf” text_font_size=”18px” text_line_height=”1.8em” header_font=”||||||||” header_2_font=”Nunito Sans|700|||||||” header_2_text_color=”#535b7c” header_2_font_size=”35px” header_2_line_height=”1.3em” header_3_font=”Nunito Sans|700|||||||” header_3_text_color=”#535b7c” header_3_font_size=”25px” header_3_line_height=”1.3em” max_width=”700px” module_alignment=”center” global_colors_info=”{}”]<\/p>\n

C) Merchant API<\/strong><\/span><\/h1>\n

[\/et_pb_text][et_pb_accordion open_toggle_background_color=”#ffffff” closed_toggle_background_color=”#ffffff” icon_color=”rgba(83,91,124,0.4)” _builder_version=”4.20.0″ toggle_text_color=”#535b7c” toggle_level=”h3″ toggle_font=”Roboto Mono|700|||||||” toggle_text_align=”left” toggle_font_size=”18px” body_font=”Roboto Mono||||||||” body_text_color=”#989db0″ body_font_size=”13px” custom_margin=”||100px|” custom_padding=”|||” border_radii=”on|4px|4px|4px|4px” border_width_all=”0px” border_color_all=”#d9d9d9″ border_style_all=”solid” box_shadow_style=”preset3″ box_shadow_color=”rgba(34,56,101,0.12)” use_border_color=”on” border_width=”0px” global_colors_info=”{}”][et_pb_accordion_item title=”Introduction” open=”on” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}”]<\/p>\n

<\/a><\/h3>\n

The information described in this section is important to note to ensure the success of integration with the OAuth 2.0 Celbux calls.<\/span><\/p>\n

Celbux supports only Authorization code (Grant Type) as their OAuth 2.0 strategy. The API\u2019s published by Celbux are REST API\u2019s that use simple HTTPS calls. <\/span><\/p>\n

A Bearer Token will be allocated for a simulation environment, as well as a the URL specifically set-up for your dedicated use. This Bearer Token should be placed in the header of the REST Call under Authentication.\u00a0 <\/span><\/p>\n

After successful completion of the simulation testing, new credentials will be supplied to you to permit operating in the live environment. <\/span><\/p>\n

By default, all response and request payloads are in JSON format.<\/span><\/p>\n

Celbux uses standard HTTP status codes when returning errors with additional fields in the body for the error name and code.<\/span><\/p>\n

 <\/p>\n

[\/et_pb_accordion_item][\/et_pb_accordion][et_pb_text module_id=”environmentsmerchant” _builder_version=”4.20.0″ text_font=”Nunito Sans||||||||” text_text_color=”#959baf” text_font_size=”18px” text_line_height=”1.8em” header_font=”||||||||” header_2_font=”Nunito Sans|700|||||||” header_2_text_color=”#535b7c” header_2_font_size=”35px” header_2_line_height=”1.3em” header_3_font=”Nunito Sans|700|||||||” header_3_text_color=”#535b7c” header_3_font_size=”25px” header_3_line_height=”1.3em” max_width=”700px” module_alignment=”center” global_colors_info=”{}”]<\/p>\n

Environments<\/h3>\n

[\/et_pb_text][et_pb_accordion open_toggle_background_color=”#ffffff” closed_toggle_background_color=”#ffffff” icon_color=”rgba(83,91,124,0.4)” _builder_version=”4.20.0″ toggle_text_color=”#535b7c” toggle_level=”h3″ toggle_font=”Roboto Mono|700|||||||” toggle_text_align=”left” toggle_font_size=”18px” body_font=”Roboto Mono||||||||” body_text_color=”#989db0″ body_font_size=”13px” custom_margin=”||100px|” custom_padding=”|||” border_radii=”on|4px|4px|4px|4px” border_width_all=”0px” border_color_all=”#d9d9d9″ border_style_all=”solid” box_shadow_style=”preset3″ box_shadow_color=”rgba(34,56,101,0.12)” use_border_color=”on” border_width=”0px” global_colors_info=”{}”][et_pb_accordion_item title=”Environments” open=”on” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}”]<\/p>\n

The environments listed below are for testing purposes only. Production environment details and user credentials will be shared once successful testing cycles have been concluded.<\/o:p><\/span><\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Simulation environment” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

The following details are to be used for testing in the simulation environment. The credentials marked with an * will be provided by Celbux. The customer and merchant password will be sent via SMS once the account has been created.<\/p>\n\n\n\n\n\n\n\n\n\n\n\n
Credential<\/td>\nDescription<\/span><\/td>\n<\/tr>\n
URL*<\/td>\n<\/td>\n<\/tr>\n
Bearer Token*<\/td>\n\u00a0<\/span><\/td>\n<\/tr>\n
MEID*<\/td>\n\u00a0<\/span><\/td>\n<\/tr>\n
StoreID*<\/td>\n\u00a0<\/span><\/td>\n<\/tr>\n
Merchant Username*<\/td>\n\u00a0<\/span><\/td>\n<\/tr>\n
Merchant Password*<\/td>\n\u00a0<\/span><\/td>\n<\/tr>\n
Customer Username<\/td>\n\u00a0<\/span><\/td>\n<\/tr>\n
Customer Password*<\/td>\n\u00a0<\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

 <\/p>\n

 <\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Simulation Testing Information” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

A test merchant and a test customer account will be activated on the simulation platform for your use. You can access your merchant and customer accounts via API.<\/p>\n

In order to transact, you will need valid voucher numbers. You can use your customer account to create a voucher. On the Celbux system we have different voucher types that can only be spent at the merchants that are accredited to receive them. Cash vouchers can be spent at any merchant. There are other voucher types such as food, book, accommodation or transport vouchers. For these vouchers a merchant will need to be configured and accredited in order to accept the voucher when redeemed by a customer.<\/p>\n

Cash vouchers will need to be created by the customer out of the cash balance available. Your test customer account will receive R 1 000 cash that can be topped up on request. After using a cash voucher, the change is put back into cash balance available and a new cash voucher needs to be created.<\/p>\n

[\/et_pb_accordion_item][\/et_pb_accordion][et_pb_text module_id=”BasicTransactionsmerchant” _builder_version=”4.20.0″ text_font=”Nunito Sans||||||||” text_text_color=”#959baf” text_font_size=”18px” text_line_height=”1.8em” header_font=”||||||||” header_2_font=”Nunito Sans|700|||||||” header_2_text_color=”#535b7c” header_2_font_size=”35px” header_2_line_height=”1.3em” header_3_font=”Nunito Sans|700|||||||” header_3_text_color=”#535b7c” header_3_font_size=”25px” header_3_line_height=”1.3em” max_width=”700px” module_alignment=”center” global_colors_info=”{}”]<\/p>\n

Basic Transactions<\/h3>\n

[\/et_pb_text][et_pb_text module_id=”Paymerchant” _builder_version=”4.20.0″ text_font=”Nunito Sans||||||||” text_text_color=”#959baf” text_font_size=”18px” text_line_height=”1.8em” header_font=”||||||||” header_2_font=”Nunito Sans|700|||||||” header_2_text_color=”#535b7c” header_2_font_size=”35px” header_2_line_height=”1.3em” header_3_font=”Nunito Sans|700|||||||” header_3_text_color=”#535b7c” header_3_font_size=”25px” header_3_line_height=”1.3em” max_width=”700px” module_alignment=”center” global_colors_info=”{}”]<\/p>\n

1 – Pay<\/h3>\n

[\/et_pb_text][et_pb_accordion open_toggle_background_color=”#ffffff” closed_toggle_background_color=”#ffffff” icon_color=”rgba(83,91,124,0.4)” _builder_version=”4.20.0″ toggle_text_color=”#535b7c” toggle_level=”h3″ toggle_font=”Roboto Mono|700|||||||” toggle_text_align=”left” toggle_font_size=”18px” body_font=”Roboto Mono||||||||” body_text_color=”#989db0″ body_font_size=”13px” custom_margin=”||100px|” custom_padding=”|||” border_radii=”on|4px|4px|4px|4px” border_width_all=”0px” border_color_all=”#d9d9d9″ border_style_all=”solid” box_shadow_style=”preset3″ box_shadow_color=”rgba(34,56,101,0.12)” use_border_color=”on” border_width=”0px” global_colors_info=”{}”][et_pb_accordion_item title=”Description” open=”on” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}”]<\/p>\n

Executes a payment transaction where the money moves from a user\u2019s wallet to a merchant wallet<\/o:p><\/span><\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Resource URL” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

https:\/\/{BaseURL}\/Pay?ns={{namespace}}<\/a><\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”PayRequest” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n\n\n\n\n\n
Name<\/span><\/td>\nType<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n<\/thead>\n
VoucherNo<\/span><\/td>\nstring<\/span><\/td>\nSource of the funds – a valid Celbux voucher number. Example: 225 00000 00000.<\/span><\/td>\n<\/tr>\n
Reference<\/span><\/td>\nstring<\/span><\/td>\nA unique transaction reference number given by the merchant. Example: 101<\/span><\/td>\n<\/tr>\n
Amount<\/span><\/td>\nint<\/span><\/td>\nTransaction amount in cents. Example:\u00a0 2000 (R 20.00)<\/span><\/td>\n<\/tr>\n
Currency<\/span><\/td>\nstring<\/span><\/td>\nThe currency of the merchant. Example:\u00a0 ZAR (ISO 4217 Currency Codes)<\/span><\/td>\n<\/tr>\n
StoreID<\/span><\/td>\nstring<\/span><\/td>\nA unique store identifier code. Example: 1234. <\/span><\/td>\n<\/tr>\n
Metadata<\/span><\/td>\nstring<\/span><\/td>\nRequest date time for transaction. Example: 2017\/08\/10 12:00<\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Request Header” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

Authorization: {{bearertoken}} <\/span><\/p>\n

Content-Type: application\/json<\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Request Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

{<\/span><\/p>\n

\u00a0 “VoucherNo”: “228-38777-05068”,<\/span><\/p>\n

\u00a0 “Reference”: “”,<\/span><\/p>\n

\u00a0 “Amount”: “100”,<\/span><\/p>\n

\u00a0 “Currency”: “ZAR”,<\/span><\/p>\n

\u00a0 “MEID”: “”,<\/span><\/p>\n

\u00a0 “StoreID”: “56239”,<\/span><\/p>\n

\u00a0 “Metadata”: “HPA1POS”,<\/span><\/p>\n

\u00a0 “RequestDT”: “2013\/01\/01”<\/span><\/p>\n

}<\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”PayResponse” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n\n\n\n\n\n\n
Name<\/span><\/td>\nType<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n<\/thead>\n
TID<\/span><\/td>\nstring<\/span><\/td>\nTID (Transaction ID) of the executed payment response<\/span><\/td>\n<\/tr>\n
Reference<\/span><\/td>\nstring<\/span><\/td>\nA unique transaction reference number given by the merchant<\/span><\/td>\n<\/tr>\n
Created<\/span><\/td>\nstring<\/span><\/td>\nTransaction execution time<\/span><\/td>\n<\/tr>\n
Amount<\/span><\/td>\nstring<\/span><\/td>\nTransaction amount in cents<\/span><\/td>\n<\/tr>\n
State<\/span><\/td>\nstring<\/span><\/td>\nTransaction state<\/span><\/td>\n<\/tr>\n
Status<\/span><\/td>\nInt<\/span><\/td>\nTransaction status<\/span><\/td>\n<\/tr>\n
Error<\/span><\/td>\nstring<\/span><\/td>\nFailure reason if applicable as notated<\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Response Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

{<\/span><\/p>\n

\u00a0 “TID”: “9626629171”,<\/span><\/p>\n

\u00a0 “Reference”: “”,<\/span><\/p>\n

\u00a0 “Created”: “2020\/11\/27 12:52”,<\/span><\/p>\n

\u00a0 “Amount”: “100”,<\/span><\/p>\n

\u00a0 “State”: “Success”,<\/span><\/p>\n

\u00a0 “Status”: “1”,<\/span><\/p>\n

\u00a0 “Error”: “”<\/span><\/p>\n

}<\/p>\n

[\/et_pb_accordion_item][\/et_pb_accordion][et_pb_text module_id=”Withdrawmerchant” _builder_version=”4.20.0″ text_font=”Nunito Sans||||||||” text_text_color=”#959baf” text_font_size=”18px” text_line_height=”1.8em” header_font=”||||||||” header_2_font=”Nunito Sans|700|||||||” header_2_text_color=”#535b7c” header_2_font_size=”35px” header_2_line_height=”1.3em” header_3_font=”Nunito Sans|700|||||||” header_3_text_color=”#535b7c” header_3_font_size=”25px” header_3_line_height=”1.3em” max_width=”700px” module_alignment=”center” global_colors_info=”{}”]<\/p>\n

2 – Withdraw<\/h3>\n

[\/et_pb_text][et_pb_accordion open_toggle_background_color=”#ffffff” closed_toggle_background_color=”#ffffff” icon_color=”rgba(83,91,124,0.4)” _builder_version=”4.20.0″ toggle_text_color=”#535b7c” toggle_level=”h3″ toggle_font=”Roboto Mono|700|||||||” toggle_text_align=”left” toggle_font_size=”18px” body_font=”Roboto Mono||||||||” body_text_color=”#989db0″ body_font_size=”13px” custom_margin=”||100px|” custom_padding=”|||” border_radii=”on|4px|4px|4px|4px” border_width_all=”0px” border_color_all=”#d9d9d9″ border_style_all=”solid” box_shadow_style=”preset3″ box_shadow_color=”rgba(34,56,101,0.12)” use_border_color=”on” border_width=”0px” locked=”off” global_colors_info=”{}”][et_pb_accordion_item title=”Description” open=”on” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}”]<\/p>\n

The merchant executes a withdrawal transaction which moves the money from the user\u2019s wallet to the merchant’s wallet.<\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Resource URL” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

https:\/\/{BaseURL}\/withdraw?ns={{namespace}}<\/a><\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”WithdrawRequest” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n\n\n\n\n\n
Name<\/span><\/td>\nType<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n<\/thead>\n
VoucherNo<\/span><\/td>\nstring<\/span><\/td>\n\n

Source of the funds – a valid Celbux voucher number. <\/span><\/p>\n

Example: 225 00000 00000<\/span><\/p>\n<\/td>\n<\/tr>\n

Reference<\/span><\/td>\nstring<\/span><\/td>\n\n

A unique transaction reference number given by the merchant. <\/span><\/p>\n

Reference numbers must be unique identifiers otherwise an error will be returned by the system.<\/span><\/p>\n

Example: 101. <\/span><\/p>\n<\/td>\n<\/tr>\n

Amount<\/span><\/td>\nint<\/span><\/td>\n\n

Transaction amount in cents. <\/span><\/p>\n

Example:\u00a0 2000 (R 20.00)<\/span><\/p>\n<\/td>\n<\/tr>\n

Currency<\/span><\/td>\nstring<\/span><\/td>\n\n

The currency of the merchant.<\/span><\/p>\n

\u00a0<\/span><\/p>\n

Example:\u00a0 ZAR (ISO 4217 Currency Codes)<\/span><\/p>\n<\/td>\n<\/tr>\n

StoreID<\/span><\/td>\nstring<\/span><\/td>\n\n

A unique store identifier code. <\/span><\/p>\n

\u00a0<\/span><\/p>\n

Example: 1234<\/span><\/p>\n<\/td>\n<\/tr>\n

Metadata<\/span><\/td>\nstring<\/span><\/td>\n\n

Any other detail that the merchant wishes to store on this transaction. <\/span><\/p>\n

\u00a0<\/span><\/p>\n

Example: Teller name<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Request Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

{<\/span><\/p>\n

\u00a0 “VoucherNo”: “228-05931-71893”,<\/span><\/p>\n

\u00a0 “Reference”: “”,<\/span><\/p>\n

\u00a0 “Amount”: “150”,<\/span><\/p>\n

\u00a0 “Currency”: “ZAR”,<\/span><\/p>\n

\u00a0 “MEID”: “”,<\/span><\/p>\n

\u00a0 “StoreID”: “56239”,<\/span><\/p>\n

\u00a0 “Metadata”: “meta1”,<\/span><\/p>\n

\u00a0 “RequestDT”: “2017\/03\/23”<\/span><\/p>\n

}<\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”WithdrawResponse” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n\n\n\n\n\n
Name<\/span><\/td>\nType<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n<\/thead>\n
TID<\/span><\/td>\nstring<\/span><\/td>\n\n

TID (Transaction ID) of the executed payment response.<\/span><\/p>\n

\u00a0<\/span><\/p>\n

Example: 1234-5678<\/span><\/p>\n<\/td>\n<\/tr>\n

Reference<\/span><\/td>\nstring<\/span><\/td>\n\n

A unique transaction reference number given by the merchant. <\/span><\/p>\n

\u00a0<\/span><\/p>\n

Example: 101.<\/span><\/p>\n<\/td>\n<\/tr>\n

Created<\/span><\/td>\nstring<\/span><\/td>\n\n

Transaction execution time.<\/span><\/p>\n

\u00a0<\/span><\/p>\n

Example: 2017\/08\/10 12:00<\/span><\/p>\n<\/td>\n<\/tr>\n

State<\/span><\/td>\nstring<\/span><\/td>\n\n

Transaction state.<\/span><\/p>\n

\u00a0<\/span><\/p>\n

Example: Confirmed, Refunded<\/span><\/p>\n<\/td>\n<\/tr>\n

Status<\/span><\/td>\nint<\/span><\/td>\n\n

Transaction status.<\/span><\/p>\n

\u00a0<\/span><\/p>\n

Example: 1 for success.<\/span><\/p>\n<\/td>\n<\/tr>\n

Error<\/span><\/td>\nString<\/span><\/td>\n\n

Failure reason if applicable as noted.<\/p>\n

 <\/p>\n

Example: Insufficient funds.<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Response Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

\u00a0{<\/span><\/p>\n

\u00a0 “TID”: “9630149199”,<\/span><\/p>\n

\u00a0 “Reference”: “”,<\/span><\/p>\n

\u00a0 “Created”: “2020\/11\/28 06:05”,<\/span><\/p>\n

\u00a0 “Amount”: “150”,<\/span><\/p>\n

\u00a0 “State”: “Success”,<\/span><\/p>\n

\u00a0 “Status”: “1”,<\/span><\/p>\n

\u00a0 “Error”: “”<\/span><\/p>\n

}<\/p>\n

[\/et_pb_accordion_item][\/et_pb_accordion][et_pb_text module_id=”depositmerchant” _builder_version=”4.20.0″ text_font=”Nunito Sans||||||||” text_text_color=”#959baf” text_font_size=”18px” text_line_height=”1.8em” header_font=”||||||||” header_2_font=”Nunito Sans|700|||||||” header_2_text_color=”#535b7c” header_2_font_size=”35px” header_2_line_height=”1.3em” header_3_font=”Nunito Sans|700|||||||” header_3_text_color=”#535b7c” header_3_font_size=”25px” header_3_line_height=”1.3em” max_width=”700px” module_alignment=”center” global_colors_info=”{}”]<\/p>\n

3 – Deposit<\/h3>\n

[\/et_pb_text][et_pb_accordion open_toggle_background_color=”#ffffff” closed_toggle_background_color=”#ffffff” icon_color=”rgba(83,91,124,0.4)” _builder_version=”4.20.0″ toggle_text_color=”#535b7c” toggle_level=”h3″ toggle_font=”Roboto Mono|700|||||||” toggle_text_align=”left” toggle_font_size=”18px” body_font=”Roboto Mono||||||||” body_text_color=”#989db0″ body_font_size=”13px” custom_margin=”||100px|” custom_padding=”|||” border_radii=”on|4px|4px|4px|4px” border_width_all=”0px” border_color_all=”#d9d9d9″ border_style_all=”solid” box_shadow_style=”preset3″ box_shadow_color=”rgba(34,56,101,0.12)” use_border_color=”on” border_width=”0px” locked=”off” global_colors_info=”{}”][et_pb_accordion_item title=”Description” open=”on” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}”]<\/p>\n

The Merchant initiates a deposit transaction to the user’s\/customer’s wallet.<\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Resource URL” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

https:\/\/{BaseURL}\/deposit?ns={{namespace}}<\/a><\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”DepositRequest” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n\n\n\n\n\n
Name<\/span><\/td>\nType<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n<\/thead>\n
VoucherNo<\/span><\/td>\nstring<\/span><\/td>\n\n

Destination of the funds – a valid Celbux bin with mobile number<\/span><\/p>\n

\u00a0<\/span><\/p>\n

Example: 225 00000 00000<\/span><\/p>\n<\/td>\n<\/tr>\n

Reference<\/span><\/td>\nstring<\/span><\/td>\n\n

A unique transaction reference number given by the merchant**<\/span><\/p>\n

\u00a0<\/span><\/p>\n

Example: 101<\/span><\/p>\n<\/td>\n<\/tr>\n

Amount<\/span><\/td>\nint<\/span><\/td>\n\n

Transaction amount in cents<\/span><\/p>\n

\u00a0<\/span><\/p>\n

Example: 2000 (R 20.00)<\/span><\/p>\n<\/td>\n<\/tr>\n

Currency<\/span><\/td>\nstring<\/span><\/td>\n\n

The currency of the merchant.<\/span><\/p>\n

\u00a0<\/span><\/p>\n

Example: ZAR (ISO 4217 Currency Codes)<\/span><\/p>\n<\/td>\n<\/tr>\n

StoreID<\/span><\/td>\nstring<\/span><\/td>\n\n

A unique store identifier code<\/span><\/p>\n

\u00a0<\/span><\/p>\n

Example: 1234<\/span><\/p>\n<\/td>\n<\/tr>\n

Metadata<\/span><\/td>\nstring<\/span><\/td>\n\n

Any other detail that the merchant wishes to store on this transaction<\/span><\/p>\n

\u00a0<\/span><\/p>\n

Example: Teller name<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Request Header” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

Authorization: {{bearertoken}} <\/span><\/p>\n

Content-Type: application\/json<\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Request Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

{<\/span><\/p>\n

\u00a0 “VoucherNo”: “228-2778800-8895”,<\/span><\/p>\n

\u00a0 “Reference”: “”,<\/span><\/p>\n

\u00a0 “Amount”: “10”,<\/span><\/p>\n

\u00a0 “Currency”: “ZAR”,<\/span><\/p>\n

\u00a0 “MEID”: “ZHQwXmR2QH8zMWFzb15eZnJR”,<\/span><\/p>\n

\u00a0 “StoreID”: “”,<\/span><\/p>\n

\u00a0 “Metadata”: “”,<\/span><\/p>\n

\u00a0 “RequestDT”: “2020\/11\/30”<\/span><\/p>\n

}<\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”DepositResponse” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n\n\n\n\n\n\n
Name<\/span><\/td>\nType<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n<\/thead>\n
TID<\/span><\/td>\nstring<\/span><\/td>\n\n

TID (Transaction ID) of the executed payment response<\/span><\/p>\n

\u00a0<\/span><\/p>\n

Example: 1234-5678<\/span><\/p>\n<\/td>\n<\/tr>\n

Reference<\/span><\/td>\nstring<\/span><\/td>\n\n

A unique transaction reference number given by the merchant<\/span><\/p>\n

\u00a0<\/span><\/p>\n

Example: 101<\/span><\/p>\n<\/td>\n<\/tr>\n

Created<\/span><\/td>\nstring<\/span><\/td>\n\n

Transaction execution time<\/span><\/p>\n

\u00a0<\/span><\/p>\n

Example: 2017\/08\/10 12:00<\/span><\/p>\n<\/td>\n<\/tr>\n

Amount<\/span><\/td>\nint<\/span><\/td>\n\n

Transaction amount in cents<\/span><\/p>\n

\u00a0<\/span><\/p>\n

Example: 2000 (R 20.00)<\/span><\/p>\n<\/td>\n<\/tr>\n

State<\/span><\/td>\nstring<\/span><\/td>\n\n

Deposit state<\/span><\/p>\n

\u00a0<\/span><\/p>\n

Example: Success, Failed<\/span><\/p>\n<\/td>\n<\/tr>\n

Status<\/span><\/td>\nint<\/span><\/td>\n\n

Deposit status<\/p>\n

 <\/p>\n

Example: 1 for success<\/span><\/p>\n<\/td>\n<\/tr>\n

Error<\/span><\/td>\nstring<\/span><\/td>\n\n

Failure reason if applicable as noted<\/span><\/p>\n

\u00a0<\/span><\/p>\n

Example: Unknown User<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Response Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

{<\/span><\/p>\n

\u00a0 “TID”: “9684409193”,<\/span><\/p>\n

\u00a0 “Reference”: “”,<\/span><\/p>\n

\u00a0 “Created”: “2021\/01\/12 08:24”,<\/span><\/p>\n

\u00a0 “Amount”: “10”,<\/span><\/p>\n

\u00a0 “State”: “Success”,<\/span><\/p>\n

\u00a0 “Status”: “1”,<\/span><\/p>\n

\u00a0 “Error”: “”<\/span><\/p>\n

}<\/p>\n

[\/et_pb_accordion_item][\/et_pb_accordion][et_pb_text module_id=”confirmmerchant” _builder_version=”4.20.0″ text_font=”Nunito Sans||||||||” text_text_color=”#959baf” text_font_size=”18px” text_line_height=”1.8em” header_font=”||||||||” header_2_font=”Nunito Sans|700|||||||” header_2_text_color=”#535b7c” header_2_font_size=”35px” header_2_line_height=”1.3em” header_3_font=”Nunito Sans|700|||||||” header_3_text_color=”#535b7c” header_3_font_size=”25px” header_3_line_height=”1.3em” max_width=”700px” module_alignment=”center” global_colors_info=”{}”]<\/p>\n

4 – Confirm<\/h3>\n

[\/et_pb_text][et_pb_accordion open_toggle_background_color=”#ffffff” closed_toggle_background_color=”#ffffff” icon_color=”rgba(83,91,124,0.4)” _builder_version=”4.20.0″ toggle_text_color=”#535b7c” toggle_level=”h3″ toggle_font=”Roboto Mono|700|||||||” toggle_text_align=”left” toggle_font_size=”18px” body_font=”Roboto Mono||||||||” body_text_color=”#989db0″ body_font_size=”13px” custom_margin=”||100px|” custom_padding=”|||” border_radii=”on|4px|4px|4px|4px” border_width_all=”0px” border_color_all=”#d9d9d9″ border_style_all=”solid” box_shadow_style=”preset3″ box_shadow_color=”rgba(34,56,101,0.12)” use_border_color=”on” border_width=”0px” global_colors_info=”{}”][et_pb_accordion_item title=”Description” open=”on” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}”]<\/p>\n

To confirm if a transaction has completed. This call can also be made to indicate a two-step confirmation of a transaction as per request.\u00a0 In the case of a two-step transaction, pass -1 to confirm and 0 to reverse.<\/span><\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Resource URL” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

https:\/\/{BaseURL}\/confirm?ns={{namespace}}<\/a><\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”ConfirmRequest” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n\n\n\n\n
Name<\/span><\/td>\nType<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n<\/thead>\n
Metadata<\/span><\/td>\nstring<\/span><\/td>\n\n

Any other detail that the merchant wishes to store on this transaction<\/span><\/p>\n

\u00a0<\/span><\/p>\n

Example: Teller name<\/span><\/p>\n<\/td>\n<\/tr>\n

Reference<\/span><\/td>\nstring<\/span><\/td>\n\n

A unique transaction reference number given by the merchant.<\/span><\/p>\n

\u00a0<\/span><\/p>\n

Reference numbers must be unique identifiers otherwise an error will be returned by the system.<\/span><\/p>\n

\u00a0<\/span><\/p>\n

Example: 12345<\/span><\/p>\n<\/td>\n<\/tr>\n

OldReference<\/span><\/td>\nstring<\/span><\/td>\n\n

If a reference number is supplied, the reference number of the original transaction must also be supplied.<\/span><\/p>\n

\u00a0<\/span><\/p>\n

Either the TID or reference number must be supplied. If a reference number is supplied, the \u201cOldReference\u201d of the original transaction is also required.<\/span><\/p>\n

\u00a0<\/span><\/p>\n

Example: 12345<\/span><\/p>\n<\/td>\n<\/tr>\n

TID<\/span><\/td>\nstring<\/span><\/td>\n\n

TID (Transaction ID) of the executed payment response.<\/span><\/p>\n

\u00a0<\/span><\/p>\n

Either the TID or reference number must be supplied.\u00a0 If a reference number is supplied, the \u201cOldReference\u201d of the original transaction is also required.<\/span><\/p>\n

\u00a0<\/span><\/p>\n

Example: 1234-5678<\/span><\/p>\n<\/td>\n<\/tr>\n

Amount<\/span><\/td>\nInt<\/span><\/td>\n\n

Enter a -1 to confirm or 0 to reverse<\/span><\/p>\n

\u00a0<\/span><\/p>\n

Example: -1 or 0<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

 <\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Request Header” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

Authorization: {{bearertoken}} <\/span><\/p>\n

Content-Type: application\/json<\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Request Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

{<\/span><\/p>\n

\u00a0 “MEID”: “”,<\/span><\/p>\n

\u00a0 “StoreID”: “56239”,<\/span><\/p>\n

\u00a0 “Reference”: “”,<\/span><\/p>\n

\u00a0 “OldReference”: “”,<\/span><\/p>\n

\u00a0 “TID”: “9626629171”,<\/span><\/p>\n

\u00a0 “Amount”: “-1”<\/span><\/p>\n

}<\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”ConfirmResponse” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n\n\n\n\n\n\n
Name<\/span><\/td>\nType<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n<\/thead>\n
TID<\/span><\/td>\nstring<\/span><\/td>\n\n

TID (Transaction ID) of the executed payment response<\/span><\/p>\n

\u00a0<\/span><\/p>\n

Example: 1234-5678<\/span><\/p>\n<\/td>\n<\/tr>\n

Reference<\/span><\/td>\nstring<\/span><\/td>\n\n

A unique transaction reference number given by the merchant<\/span><\/p>\n

\u00a0<\/span><\/p>\n

Example: 101<\/span><\/p>\n<\/td>\n<\/tr>\n

OldReference<\/span><\/td>\nstring<\/span><\/td>\n\n

The reference number given to the original transaction<\/span><\/p>\n

\u00a0<\/span><\/p>\n

Example: 101<\/span><\/p>\n<\/td>\n<\/tr>\n

Created<\/span><\/td>\nstring<\/span><\/td>\n\n

Transaction execution time.<\/span><\/p>\n

\u00a0<\/span><\/p>\n

Example: 2017\/08\/10 12:00<\/span><\/p>\n<\/td>\n<\/tr>\n

State<\/span><\/td>\nstring<\/span><\/td>\n\n

Transaction state.<\/span><\/p>\n

\u00a0<\/span><\/p>\n

Example: Confirmed, Refunded<\/span><\/p>\n<\/td>\n<\/tr>\n

Status<\/span><\/td>\nint<\/span><\/td>\n\n

Transaction status.<\/p>\n

 <\/p>\n

Example: 1 for success.<\/span><\/p>\n<\/td>\n<\/tr>\n

Error<\/span><\/td>\nstring<\/span><\/td>\n\n

Failure reason if applicable as noted<\/span><\/p>\n

\u00a0<\/span><\/p>\n

Example: Insufficient funds.<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

 <\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Response Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

\u00a0 {<\/span><\/p>\n

\u00a0 “TID”: “9626629171”,<\/span><\/p>\n

\u00a0 “Reference”: “”,<\/span><\/p>\n

\u00a0 “OldReference”: “”,<\/span><\/p>\n

\u00a0 “Created”: “2020\/11\/27 13:22”,<\/span><\/p>\n

\u00a0 “State”: “Confirmed”,<\/span><\/p>\n

\u00a0 “Status”: “1”,<\/span><\/p>\n

\u00a0 “Error”: “”<\/span><\/p>\n

}<\/p>\n

[\/et_pb_accordion_item][\/et_pb_accordion][et_pb_text module_id=”paymentmerchant” _builder_version=”4.20.0″ text_font=”Nunito Sans||||||||” text_text_color=”#959baf” text_font_size=”18px” text_line_height=”1.8em” header_font=”||||||||” header_2_font=”Nunito Sans|700|||||||” header_2_text_color=”#535b7c” header_2_font_size=”35px” header_2_line_height=”1.3em” header_3_font=”Nunito Sans|700|||||||” header_3_text_color=”#535b7c” header_3_font_size=”25px” header_3_line_height=”1.3em” max_width=”700px” module_alignment=”center” global_colors_info=”{}”]<\/p>\n

5 – Payment<\/h3>\n

[\/et_pb_text][et_pb_accordion open_toggle_background_color=”#ffffff” closed_toggle_background_color=”#ffffff” icon_color=”rgba(83,91,124,0.4)” _builder_version=”4.20.0″ toggle_text_color=”#535b7c” toggle_level=”h3″ toggle_font=”Roboto Mono|700|||||||” toggle_text_align=”left” toggle_font_size=”18px” body_font=”Roboto Mono||||||||” body_text_color=”#989db0″ body_font_size=”13px” custom_margin=”||100px|” custom_padding=”|||” border_radii=”on|4px|4px|4px|4px” border_width_all=”0px” border_color_all=”#d9d9d9″ border_style_all=”solid” box_shadow_style=”preset3″ box_shadow_color=”rgba(34,56,101,0.12)” use_border_color=”on” border_width=”0px” locked=”off” global_colors_info=”{}”][et_pb_accordion_item title=”Description” open=”on” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}”]<\/p>\n

Pass the StoreID and the payment TID to retrieve details about an individual pay transaction.<\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Resource URL” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

https:\/\/{BaseURL}\/payment?ns={{namespace}}<\/a><\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”PaymentRequest” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n\n\n
Name<\/span><\/td>\nType<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n<\/thead>\n
StoreID<\/span><\/td>\nstring<\/span><\/td>\n\n

A unique store identifier code.<\/span><\/p>\n

\u00a0<\/span><\/p>\n

Example: 123<\/span><\/p>\n<\/td>\n<\/tr>\n

TID<\/span><\/td>\nstring<\/span><\/td>\n\n

TID (Transaction ID) of the executed payment response.<\/span><\/p>\n

\u00a0<\/span><\/p>\n

Either the TID or reference number must be supplied.\u00a0 If a reference number is supplied, the \u201cOldReference\u201d of the original transaction is also required.<\/span><\/p>\n

\u00a0<\/span><\/p>\n

Example: 1234-5678<\/span><\/p>\n<\/td>\n<\/tr>\n

Metadata<\/span><\/td>\nstring<\/span><\/td>\n\n

Any other detail that the merchant wishes to store on this transaction<\/span><\/p>\n

\u00a0<\/span><\/p>\n

Example: Teller name<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Request Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

{<\/span><\/p>\n

\u00a0 “TID”: “”,<\/span><\/p>\n

\u00a0 “StoreID”: “Celbux”,<\/span><\/p>\n

\u00a0 “Metadata”: “{\\”ActionID\\”: \\”b37beb5b-e5d5-495c-8525-90b275ff4310\\”}”<\/span><\/p>\n

}<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”PaymentResponse” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n\n\n\n\n\n\n
Name<\/span><\/td>\nType<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n<\/thead>\n
TID<\/span><\/td>\nstring<\/span><\/td>\n\n

TID (Transaction ID) of the executed payment response.<\/span><\/p>\n

\u00a0<\/span><\/p>\n

Example: 1234-5678<\/span><\/p>\n<\/td>\n<\/tr>\n

Reference<\/span><\/td>\nstring<\/span><\/td>\n\n

A unique transaction reference number given by the merchant.<\/span><\/p>\n

\u00a0<\/span><\/p>\n

Example: 101<\/span><\/p>\n<\/td>\n<\/tr>\n

Created<\/span><\/td>\nstring<\/span><\/td>\n\n

Transaction execution time.<\/span><\/p>\n

\u00a0<\/span><\/p>\n

Example: 2017\/08\/10 12:00<\/span><\/p>\n<\/td>\n<\/tr>\n

Amount<\/span><\/td>\nint<\/span><\/td>\n\n

Transaction amount in cents.<\/span><\/p>\n

\u00a0<\/span><\/p>\n

Example: 2000 (R 20.00)<\/span><\/p>\n<\/td>\n<\/tr>\n

State<\/span><\/td>\nstring<\/span><\/td>\n\n

Transaction state.<\/span><\/p>\n

\u00a0<\/span><\/p>\n

Example: Success, Failed<\/span><\/p>\n<\/td>\n<\/tr>\n

Status<\/span><\/td>\nint<\/span><\/td>\n\n

Transaction status.<\/span><\/p>\n

\u00a0<\/span><\/p>\n

Example: 1 for success<\/span><\/p>\n<\/td>\n<\/tr>\n

Error<\/span><\/td>\nstring<\/span><\/td>\n\n

Failure reason if applicable as notated.<\/span><\/p>\n

\u00a0<\/span><\/p>\n

Example: Insufficient funds<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Response Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

{<\/span><\/p>\n

\u00a0 “TID”: “9636209172”,<\/span><\/p>\n

\u00a0 “Reference”: “”,<\/span><\/p>\n

\u00a0 “Created”: “2020\/12\/01 17:23”,<\/span><\/p>\n

\u00a0 “Amount”: “250”,<\/span><\/p>\n

\u00a0 “State”: “Success”,<\/span><\/p>\n

\u00a0 “Status”: “1”,<\/span><\/p>\n

\u00a0 “Error”: “”<\/span><\/p>\n

}<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][\/et_pb_accordion][\/et_pb_column][\/et_pb_row][et_pb_row column_structure=”1_4,3_4″ use_custom_gutter=”on” gutter_width=”2″ _builder_version=”4.20.0″ custom_padding=”87px|||||” global_colors_info=”{}”][et_pb_column type=”1_4″ _builder_version=”4.16″ background_color_gradient_direction=”243deg” background_color_gradient_start=”#3D72E7″ background_color_gradient_end=”#53a0fe” custom_padding=”|||” global_colors_info=”{}” custom_padding__hover=”|||”][\/et_pb_column][et_pb_column type=”3_4″ _builder_version=”4.16″ background_color_gradient_direction=”243deg” background_color_gradient_start=”#3D72E7″ background_color_gradient_end=”#53a0fe” custom_padding=”|||” global_colors_info=”{}” custom_padding__hover=”|||”][et_pb_text module_id=”AdministrativeAPI” _builder_version=”4.20.0″ text_font=”Nunito Sans||||||||” text_text_color=”#959baf” text_font_size=”18px” text_line_height=”1.8em” header_font=”||||||||” header_2_font=”Nunito Sans|700|||||||” header_2_text_color=”#535b7c” header_2_font_size=”35px” header_2_line_height=”1.3em” header_3_font=”Nunito Sans|700|||||||” header_3_text_color=”#535b7c” header_3_font_size=”25px” header_3_line_height=”1.3em” max_width=”700px” module_alignment=”center” global_colors_info=”{}”]<\/p>\n

D) Administrative API<\/strong><\/span><\/h1>\n

[\/et_pb_text][et_pb_accordion open_toggle_background_color=”#ffffff” closed_toggle_background_color=”#ffffff” icon_color=”rgba(83,91,124,0.4)” _builder_version=”4.20.0″ toggle_text_color=”#535b7c” toggle_level=”h3″ toggle_font=”Roboto Mono|700|||||||” toggle_text_align=”left” toggle_font_size=”18px” body_font=”Roboto Mono||||||||” body_text_color=”#989db0″ body_font_size=”13px” custom_margin=”||100px|” custom_padding=”|||” border_radii=”on|4px|4px|4px|4px” border_width_all=”0px” border_color_all=”#d9d9d9″ border_style_all=”solid” box_shadow_style=”preset3″ box_shadow_color=”rgba(34,56,101,0.12)” use_border_color=”on” border_width=”0px” global_colors_info=”{}”][et_pb_accordion_item title=”1 – Introduction” open=”on” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}”]<\/p>\n

The information described in this section is important to ensure successful integration with the Celbux Administrative API calls.<\/span><\/p>\n

The Celbux API is a REST API that uses simple HTTP calls.\u00a0 This document describes various API calls to the Celbux platform.<\/span><\/p>\n

API access to the Celbux platform requires a valid bearer token and an active URL endpoint. The URL endpoint has to be part of the POST or GET call structure and is inserted at the place holder {URL} on the calls in this document. The bearer token is used to authenticate API calls to the platform, and it should be placed in the header of the call under Authorization.<\/span><\/p>\n

A simulation platform, consisting of a bearer token and URL endpoint, will be made available to you for testing basic connectivity to the platform. To test the API, the {Base URL} in the call needs to be changed to the simulation URL.This will enable you to test the API calls as specified to ensure that all of these are functional. Credentials will include a bearer token, URL endpoint, test merchant and test customer.<\/span><\/p>\n

After successful completion of the simulation testing, new credentials will be supplied to you to permit operating in the live environment. <\/span><\/p>\n

By default, all response and request payloads are in JSON format.<\/span><\/p>\n

Celbux uses standard HTTP status codes when returning errors with additional fields in the body for the error description and code.<\/span><\/p>\n

 <\/p>\n

[\/et_pb_accordion_item][\/et_pb_accordion][et_pb_text module_id=”SimulationEnvironment” _builder_version=”4.20.0″ text_font=”Nunito Sans||||||||” text_text_color=”#959baf” text_font_size=”18px” text_line_height=”1.8em” header_font=”||||||||” header_2_font=”Nunito Sans|700|||||||” header_2_text_color=”#535b7c” header_2_font_size=”35px” header_2_line_height=”1.3em” header_3_font=”Nunito Sans|700|||||||” header_3_text_color=”#535b7c” header_3_font_size=”25px” header_3_line_height=”1.3em” max_width=”700px” module_alignment=”center” global_colors_info=”{}”]<\/p>\n

2 – Environments<\/h3>\n

[\/et_pb_text][et_pb_accordion open_toggle_background_color=”#ffffff” closed_toggle_background_color=”#ffffff” icon_color=”rgba(83,91,124,0.4)” _builder_version=”4.20.0″ toggle_text_color=”#535b7c” toggle_level=”h3″ toggle_font=”Roboto Mono|700|||||||” toggle_text_align=”left” toggle_font_size=”18px” body_font=”Roboto Mono||||||||” body_text_color=”#989db0″ body_font_size=”13px” custom_margin=”||100px|” custom_padding=”|||” border_radii=”on|4px|4px|4px|4px” border_width_all=”0px” border_color_all=”#d9d9d9″ border_style_all=”solid” box_shadow_style=”preset3″ box_shadow_color=”rgba(34,56,101,0.12)” use_border_color=”on” border_width=”0px” global_colors_info=”{}”][et_pb_accordion_item title=”Environments” open=”on” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}”]<\/p>\n

The environments listed below are for testing purposes only. Production environment details and user credentials will be shared once successful testing cycles have been concluded.<\/o:p><\/span><\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Simulation environment” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

The following details are to be used for testing in the simulation environment. The credentials marked with an * will be provided by Celbux. The customer and merchant password will be sent via SMS once the account has been created.<\/p>\n

\"\"<\/p>\n

 <\/p>\n

 <\/p>\n

[\/et_pb_accordion_item][\/et_pb_accordion][et_pb_text module_id=”AddUserstoCommunitiesadministrative” _builder_version=”4.20.0″ text_font=”Nunito Sans||||||||” text_text_color=”#959baf” text_font_size=”18px” text_line_height=”1.8em” header_font=”||||||||” header_2_font=”Nunito Sans|700|||||||” header_2_text_color=”#535b7c” header_2_font_size=”35px” header_2_line_height=”1.3em” header_3_font=”Nunito Sans|700|||||||” header_3_text_color=”#535b7c” header_3_font_size=”25px” header_3_line_height=”1.3em” max_width=”700px” module_alignment=”center” global_colors_info=”{}”]<\/p>\n

1 – Add Users to Communities<\/h3>\n

[\/et_pb_text][et_pb_accordion open_toggle_background_color=”#ffffff” closed_toggle_background_color=”#ffffff” icon_color=”rgba(83,91,124,0.4)” _builder_version=”4.20.0″ toggle_text_color=”#535b7c” toggle_level=”h3″ toggle_font=”Roboto Mono|700|||||||” toggle_text_align=”left” toggle_font_size=”18px” body_font=”Roboto Mono||||||||” body_text_color=”#989db0″ body_font_size=”13px” custom_margin=”||100px|” custom_padding=”|||” border_radii=”on|4px|4px|4px|4px” border_width_all=”0px” border_color_all=”#d9d9d9″ border_style_all=”solid” box_shadow_style=”preset3″ box_shadow_color=”rgba(34,56,101,0.12)” use_border_color=”on” border_width=”0px” global_colors_info=”{}”][et_pb_accordion_item title=”Description” open=”on” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}”]<\/p>\n

Add users and merchants account to communities <\/o:p><\/span><\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Resource URL” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

https:\/\/{BaseURL}\/addUsersToCommunities?ns={{namespace}}<\/p>\n

 <\/p>\n

 <\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”addUsersToCommunities Request” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

\"\"<\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Request Header” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

Authorization: {{bearertoken}} <\/span><\/p>\n

Content-Type: application\/json<\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Request Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

{<\/span><\/p>\n

\u00a0\u00a0\u00a0 “MSISDNs”: “Merchant1”, <\/span><\/p>\n

\u00a0\u00a0\u00a0 “Communities”: “celbux101”, <\/span><\/p>\n

“Metadata”: “{\\”ActionID\\”: \\”b37beb5b-e5d5-495c-8525-90b275ff4310\\”}”<\/p>\n

}<\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”addUsersToCommunities Response” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n\n\n\n
Name<\/span><\/td>\nType<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n<\/thead>\n
TID<\/span><\/td>\nstring<\/span><\/td>\n\n

TID (Transaction ID) of the executed API call<\/span><\/p>\n

Example: 1234-5678<\/span><\/p>\n<\/td>\n<\/tr>\n

State<\/span><\/td>\nstring<\/span><\/td>\n\n

Transaction state.<\/span><\/p>\n

Example: Confirmed, Refunded<\/span><\/p>\n<\/td>\n<\/tr>\n

Status<\/span><\/td>\nInt<\/span><\/td>\n\n

Transaction status.<\/span><\/p>\n

Example: 1 for success.<\/span><\/p>\n<\/td>\n<\/tr>\n

Error<\/span><\/td>\nstring<\/span><\/td>\n\n

Failure reason if applicable as noted.<\/p>\n

Example: Insufficient funds.<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Response Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

{<\/span><\/p>\n

\u00a0 “TID”: “9626629171”,<\/span><\/p>\n

\u00a0 “State”: “Success”,<\/span><\/p>\n

\u00a0 “Status”: “1”,<\/span><\/p>\n

\u00a0 “Error”: “”<\/span><\/p>\n

}<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][\/et_pb_accordion][et_pb_text module_id=”ChangeMSISDN” _builder_version=”4.20.0″ text_font=”Nunito Sans||||||||” text_text_color=”#959baf” text_font_size=”18px” text_line_height=”1.8em” header_font=”||||||||” header_2_font=”Nunito Sans|700|||||||” header_2_text_color=”#535b7c” header_2_font_size=”35px” header_2_line_height=”1.3em” header_3_font=”Nunito Sans|700|||||||” header_3_text_color=”#535b7c” header_3_font_size=”25px” header_3_line_height=”1.3em” max_width=”700px” module_alignment=”center” global_colors_info=”{}”]<\/p>\n

2 – Change MSISDN<\/h3>\n

[\/et_pb_text][et_pb_accordion open_toggle_background_color=”#ffffff” closed_toggle_background_color=”#ffffff” icon_color=”rgba(83,91,124,0.4)” _builder_version=”4.20.0″ toggle_text_color=”#535b7c” toggle_level=”h3″ toggle_font=”Roboto Mono|700|||||||” toggle_text_align=”left” toggle_font_size=”18px” body_font=”Roboto Mono||||||||” body_text_color=”#989db0″ body_font_size=”13px” custom_margin=”||100px|” custom_padding=”|||” border_radii=”on|4px|4px|4px|4px” border_width_all=”0px” border_color_all=”#d9d9d9″ border_style_all=”solid” box_shadow_style=”preset3″ box_shadow_color=”rgba(34,56,101,0.12)” use_border_color=”on” border_width=”0px” global_colors_info=”{}”][et_pb_accordion_item title=”Description” open=”on” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}”]<\/p>\n

Use this call to Change Mobile Number<\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Resource URL” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

https:\/\/{BaseURL}\/changeMSISDN?ns={{namespace}}<\/a><\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”changeMSISDN Request” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n\n\n\n\n\n
Name<\/span><\/td>\nType<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n<\/thead>\n
\n

ID Number<\/span><\/strong><\/p>\n

\u00a0<\/span><\/p>\n<\/td>\n

string<\/span><\/td>\n\n

RSA ID number 13 digit<\/p>\n

\u00a0<\/span><\/p>\n<\/td>\n<\/tr>\n

\n

OldMSISDN<\/span><\/strong><\/p>\n

\u00a0<\/span><\/p>\n<\/td>\n

String<\/span><\/td>\n\n

Old Mobile number<\/p>\n

\u00a0<\/span><\/p>\n<\/td>\n<\/tr>\n

Reference<\/span><\/td>\nstring<\/span><\/td>\n\n

A unique transaction reference number given by the merchant. <\/span><\/p>\n

Reference numbers must be unique identifiers otherwise an error will be returned by the system.<\/span><\/p>\n

Example: 101.<\/span><\/p>\n<\/td>\n<\/tr>\n

\n

NewMSISDN<\/span><\/strong><\/p>\n

\u00a0<\/span><\/p>\n<\/td>\n

string<\/span><\/td>\n\n

New Mobile number<\/p>\n

\u00a0<\/span><\/p>\n<\/td>\n<\/tr>\n

\n

Metadata<\/span><\/strong><\/p>\n

\u00a0<\/span><\/p>\n<\/td>\n

string<\/span><\/td>\n\n

Any other detail that the merchant wishes to store on this transaction. <\/span><\/p>\n

Example: Teller name<\/span><\/p>\n<\/td>\n<\/tr>\n

OTP<\/span><\/strong><\/td>\nString<\/span><\/td>\nOne Time Pin number<\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Request Header” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

Authorization: {{bearertoken}} <\/span><\/p>\n

Content-Type: application\/json<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Request Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

{<\/span><\/p>\n

\u00a0 \u00a0\u00a0“OldMSISDN”: “0648503047”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “IDNumber”: “”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “NewMSISDN”: “0648503049”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “OTP”: “437147”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “Reference”: “{{$timestamp}}”,<\/span><\/p>\n

“Metadata”: “{\\”ActionID\\”: \\”b37beb5b-e5d5-495c-8525-90b275ff4310\\”}”<\/p>\n

}<\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”changeMSISDN Response” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n\n\n\n\n
Name<\/span><\/td>\nType<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n<\/thead>\n
TID<\/span><\/td>\nstring<\/span><\/td>\n\n

TID (Transaction ID) of the executed API call<\/span><\/p>\n

\u00a0<\/span><\/p>\n

Example: 1234-5678<\/span><\/p>\n<\/td>\n<\/tr>\n

Reference<\/span><\/td>\nstring<\/span><\/td>\n\n

A unique transaction reference number given by the merchant. <\/span><\/p>\n

\u00a0<\/span><\/p>\n

Example: 101.<\/span><\/p>\n<\/td>\n<\/tr>\n

State<\/span><\/td>\nstring<\/span><\/td>\n\n

Transaction state.<\/span><\/p>\n

\u00a0<\/span><\/p>\n

Example: Confirmed, Refunded<\/span><\/p>\n<\/td>\n<\/tr>\n

Status<\/span><\/td>\nint<\/span><\/td>\n\n

Transaction status.<\/span><\/p>\n

\u00a0<\/span><\/p>\n

Example: 1 for success.<\/span><\/p>\n<\/td>\n<\/tr>\n

Error<\/span><\/td>\nString<\/span><\/td>\n\n

Failure reason if applicable as noted.<\/p>\n

 <\/p>\n

Example: Insufficient funds.<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Response Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

\u00a0{<\/span><\/p>\n

\u00a0 “TID”: “9630149199”,<\/span><\/p>\n

\u00a0 “Reference”: ” 1707385761″,<\/span><\/p>\n

\u00a0 “State”: “Success”,<\/span><\/p>\n

\u00a0 “Status”: “1”,<\/span><\/p>\n

\u00a0 “Error”: “”<\/span><\/p>\n

}<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][\/et_pb_accordion][et_pb_text module_id=”CreateBearerToken” _builder_version=”4.20.0″ text_font=”Nunito Sans||||||||” text_text_color=”#959baf” text_font_size=”18px” text_line_height=”1.8em” header_font=”||||||||” header_2_font=”Nunito Sans|700|||||||” header_2_text_color=”#535b7c” header_2_font_size=”35px” header_2_line_height=”1.3em” header_3_font=”Nunito Sans|700|||||||” header_3_text_color=”#535b7c” header_3_font_size=”25px” header_3_line_height=”1.3em” max_width=”700px” module_alignment=”center” global_colors_info=”{}”]<\/p>\n

3 – Create Bearer Token<\/h3>\n

[\/et_pb_text][et_pb_accordion open_toggle_background_color=”#ffffff” closed_toggle_background_color=”#ffffff” icon_color=”rgba(83,91,124,0.4)” _builder_version=”4.20.0″ toggle_text_color=”#535b7c” toggle_level=”h3″ toggle_font=”Roboto Mono|700|||||||” toggle_text_align=”left” toggle_font_size=”18px” body_font=”Roboto Mono||||||||” body_text_color=”#989db0″ body_font_size=”13px” custom_margin=”||100px|” custom_padding=”|||” border_radii=”on|4px|4px|4px|4px” border_width_all=”0px” border_color_all=”#d9d9d9″ border_style_all=”solid” box_shadow_style=”preset3″ box_shadow_color=”rgba(34,56,101,0.12)” use_border_color=”on” border_width=”0px” global_colors_info=”{}”][et_pb_accordion_item title=”Description” open=”on” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}”]<\/p>\n

To create a Bearer Token on the platform<\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Resource URL” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

https:\/\/{BaseURL}\/createBearerToken?ns={{namespace}}<\/a><\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”createBearerToken Request” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n\n\n\n
Name<\/span><\/td>\nType<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n<\/thead>\n
BearerToken<\/span><\/td>\nstring<\/span><\/td>\n\n

Security token used for API authentication<\/span><\/p>\n

Example: Ty574u9vfBnYY54592jfl5474<\/span><\/p>\n<\/td>\n<\/tr>\n

Title<\/span><\/td>\nstring<\/span><\/td>\n\n

Unique name of the Bearer Token<\/span><\/p>\n

\u00a0<\/span><\/p>\n<\/td>\n<\/tr>\n

Expiry<\/span><\/td>\nString<\/span><\/td>\nExpiry date and time<\/span><\/td>\n<\/tr>\n
Metadata<\/span><\/td>\nstring<\/span><\/td>\n\n

Any other detail that the merchant wishes to store on this transaction<\/span><\/p>\n

Example: Teller name<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Request Header” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

Authorization: {{bearertoken}} <\/span><\/p>\n

Content-Type: application\/json<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Request Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

{<\/span><\/p>\n

\u00a0\u00a0\u00a0 “BearerToken”: “jM3hxb7BVaDsl5RqRf8qsSdOPJWKh1PEIcgmAHAbyXg=”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “Title”: “Celbux International”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “Expiry”: “”, \/\/ leave blank for no expiry<\/span><\/p>\n

\u00a0\u00a0\u00a0 <\/span>“Metadata”: “{\\”ActionID\\”: \\”b37beb5b-e5d5-495c-8525-90b275ff4310\\”}”<\/p>\n

}<\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”createBearerToken Response” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n\n\n\n
Name<\/span><\/td>\nType<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n<\/thead>\n
TID<\/span><\/td>\nstring<\/span><\/td>\n\n

TID (Transaction ID) of the executed API call<\/span><\/p>\n

Example: 1234-5678<\/span><\/p>\n<\/td>\n<\/tr>\n

State<\/span><\/td>\nstring<\/span><\/td>\n\n

Transaction state<\/span><\/p>\n

Example: Success, Failed<\/span><\/p>\n<\/td>\n<\/tr>\n

Status<\/span><\/td>\nint<\/span><\/td>\n\n

Transaction status<\/p>\n

Example: 1 for success<\/span><\/p>\n<\/td>\n<\/tr>\n

Error<\/span><\/td>\nstring<\/span><\/td>\n\n

Failure reason if applicable as noted<\/span><\/p>\n

Example: Unknown User<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Response Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

{<\/span><\/p>\n

\u00a0 “TID”: “9684409193”,<\/span><\/p>\n

\u00a0 “State”: “Success”,<\/span><\/p>\n

\u00a0 “Status”: “1”,<\/span><\/p>\n

\u00a0 “Error”: “”<\/span><\/p>\n

}<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][\/et_pb_accordion][et_pb_text module_id=”CreateMerchantRoute” _builder_version=”4.20.0″ text_font=”Nunito Sans||||||||” text_text_color=”#959baf” text_font_size=”18px” text_line_height=”1.8em” header_font=”||||||||” header_2_font=”Nunito Sans|700|||||||” header_2_text_color=”#535b7c” header_2_font_size=”35px” header_2_line_height=”1.3em” header_3_font=”Nunito Sans|700|||||||” header_3_text_color=”#535b7c” header_3_font_size=”25px” header_3_line_height=”1.3em” max_width=”700px” module_alignment=”center” global_colors_info=”{}”]<\/p>\n

4 – Create Merchant Route<\/h3>\n

[\/et_pb_text][et_pb_accordion open_toggle_background_color=”#ffffff” closed_toggle_background_color=”#ffffff” icon_color=”rgba(83,91,124,0.4)” _builder_version=”4.20.0″ toggle_text_color=”#535b7c” toggle_level=”h3″ toggle_font=”Roboto Mono|700|||||||” toggle_text_align=”left” toggle_font_size=”18px” body_font=”Roboto Mono||||||||” body_text_color=”#989db0″ body_font_size=”13px” custom_margin=”||100px|” custom_padding=”|||” border_radii=”on|4px|4px|4px|4px” border_width_all=”0px” border_color_all=”#d9d9d9″ border_style_all=”solid” box_shadow_style=”preset3″ box_shadow_color=”rgba(34,56,101,0.12)” use_border_color=”on” border_width=”0px” global_colors_info=”{}”][et_pb_accordion_item title=”Description” open=”on” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}”]<\/p>\n

To create a merchant route between communities<\/o:p><\/span><\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Resource URL” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

https:\/\/{BaseURL}\/createMerchantRoute?ns={{namespace}}<\/a><\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”createMerchantRoute Request” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n\n\n\n\n
Name<\/span><\/td>\nType<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n<\/thead>\n
BearerToken<\/span><\/td>\nstring<\/span><\/td>\n\n

Security token used for authentication<\/span><\/p>\n

Example: Ty574u9vfBnYY54592jfl5474<\/span><\/p>\n<\/td>\n<\/tr>\n

StoreID<\/span><\/td>\nstring<\/span><\/td>\n\n

A unique store identifier code<\/span><\/p>\n

Example: 12345<\/span><\/p>\n<\/td>\n<\/tr>\n

VoucherPrefix<\/span><\/td>\nstring<\/span><\/td>\n\n

Voucher prefix number<\/span><\/p>\n

Example: 355<\/span><\/p>\n<\/td>\n<\/tr>\n

Route<\/span><\/td>\nString<\/span><\/td>\nCommunity URL<\/span><\/td>\n<\/tr>\n
Metadata<\/span><\/td>\nstring<\/span><\/td>\n\n

Any other detail that the merchant wishes to store on this transaction<\/span><\/p>\n

Example: Teller name<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Request Header” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

Authorization: {{bearertoken}} <\/span><\/p>\n

Content-Type: application\/json<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Request Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

{<\/span><\/p>\n

\u00a0\u00a0\u00a0 “BearerToken”: “jM3hxb7BVaDsl5RqRf8qsSdOPJWKh1PEIcgmAHAbyXg=”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “StoreID”: “Celbux”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “VoucherPrefix”: “335”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “Route”: “https:\/\/dev1celbux.appspot.com”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 <\/span>“Metadata”: “{\\”ActionID\\”: \\”b37beb5b-e5d5-495c-8525-90b275ff4310\\”}”<\/p>\n

}<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”createMerchantRoute Response” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n\n\n\n
Name<\/span><\/td>\nType<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n<\/thead>\n
TID<\/span><\/td>\nstring<\/span><\/td>\n\n

TID (Transaction ID) of the executed API call<\/span><\/p>\n

Example: 1234-5678<\/span><\/p>\n<\/td>\n<\/tr>\n

State<\/span><\/td>\nstring<\/span><\/td>\n\n

Transaction state.<\/span><\/p>\n

Example: Confirmed, Refunded<\/span><\/p>\n<\/td>\n<\/tr>\n

Status<\/span><\/td>\nint<\/span><\/td>\n\n

Transaction status.<\/p>\n

Example: 1 for success.<\/span><\/p>\n<\/td>\n<\/tr>\n

Error<\/span><\/td>\nstring<\/span><\/td>\n\n

Failure reason if applicable as noted<\/span><\/p>\n

Example: Insufficient funds.<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Response Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

\u00a0 {<\/span><\/p>\n

\u00a0 “TID”: “9626629171”,<\/span><\/p>\n

\u00a0 “State”: “Confirmed”,<\/span><\/p>\n

\u00a0 “Status”: “1”,<\/span><\/p>\n

\u00a0 “Error”: “”<\/span><\/p>\n

}<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][\/et_pb_accordion][et_pb_text module_id=”CreateMerchantStore” _builder_version=”4.20.0″ text_font=”Nunito Sans||||||||” text_text_color=”#959baf” text_font_size=”18px” text_line_height=”1.8em” header_font=”||||||||” header_2_font=”Nunito Sans|700|||||||” header_2_text_color=”#535b7c” header_2_font_size=”35px” header_2_line_height=”1.3em” header_3_font=”Nunito Sans|700|||||||” header_3_text_color=”#535b7c” header_3_font_size=”25px” header_3_line_height=”1.3em” max_width=”700px” module_alignment=”center” global_colors_info=”{}”]<\/p>\n

5 – Create Merchant Store<\/h3>\n

[\/et_pb_text][et_pb_accordion open_toggle_background_color=”#ffffff” closed_toggle_background_color=”#ffffff” icon_color=”rgba(83,91,124,0.4)” _builder_version=”4.20.0″ toggle_text_color=”#535b7c” toggle_level=”h3″ toggle_font=”Roboto Mono|700|||||||” toggle_text_align=”left” toggle_font_size=”18px” body_font=”Roboto Mono||||||||” body_text_color=”#989db0″ body_font_size=”13px” custom_margin=”||100px|” custom_padding=”|||” border_radii=”on|4px|4px|4px|4px” border_width_all=”0px” border_color_all=”#d9d9d9″ border_style_all=”solid” box_shadow_style=”preset3″ box_shadow_color=”rgba(34,56,101,0.12)” use_border_color=”on” border_width=”0px” global_colors_info=”{}”][et_pb_accordion_item title=”Description” open=”on” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}”]<\/p>\n

To create a merchant store account<\/o:p><\/span><\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Resource URL” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

https:\/\/{BaseURL}\/createMerchantStore?ns={{namespace}}<\/a><\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”createMerchantStore Request” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n\n\n\n
Name<\/span><\/td>\nType<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n<\/thead>\n
BearerToken<\/span><\/td>\nstring<\/span><\/td>\n\n

Security token used for authentication<\/span><\/p>\n

Example: Ty574u9vfBnYY54592jfl5474<\/span><\/p>\n<\/td>\n<\/tr>\n

StoreID<\/span><\/td>\nstring<\/span><\/td>\n\n

A unique store identifier code<\/span><\/p>\n

Example: 12345<\/span><\/p>\n<\/td>\n<\/tr>\n

Merchant<\/span><\/td>\nstring<\/span><\/td>\nMerchant name<\/span><\/td>\n<\/tr>\n
Metadata<\/span><\/td>\nstring<\/span><\/td>\n\n

Any other detail that the merchant wishes to store on this transaction<\/span><\/p>\n

Example: Teller name<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Request Header” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

Authorization: {{bearertoken}} <\/span><\/p>\n

Content-Type: application\/json<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Request Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

{<\/span><\/p>\n

\u00a0\u00a0\u00a0 “BearerToken”: “jM3hxb7BVaDsl5RqRf8qsSdOPJWKh1PEIcgmAHAbyXg=”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “Merchant”: “Merchant1”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “StoreID”: “Store1”,<\/span><\/p>\n

“Metadata”: “{\\”ActionID\\”: \\”b37beb5b-e5d5-495c-8525-90b275ff4310\\”}”<\/p>\n

}<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”createMerchantStore Response” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n\n\n\n
Name<\/span><\/td>\nType<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n<\/thead>\n
TID<\/span><\/td>\nstring<\/span><\/td>\n\n

TID (Transaction ID) of the executed API call<\/span><\/p>\n

Example: 1234-5678<\/span><\/p>\n<\/td>\n<\/tr>\n

State<\/span><\/td>\nstring<\/span><\/td>\n\n

Transaction state.<\/span><\/p>\n

Example: Confirmed, Refunded<\/span><\/p>\n<\/td>\n<\/tr>\n

Status<\/span><\/td>\nint<\/span><\/td>\n\n

Transaction status.<\/p>\n

Example: 1 for success.<\/span><\/p>\n<\/td>\n<\/tr>\n

Error<\/span><\/td>\nstring<\/span><\/td>\n\n

Failure reason if applicable as noted<\/span><\/p>\n

Example: Insufficient funds.<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Response Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

\u00a0 {<\/span><\/p>\n

\u00a0 “TID”: “9626629171”,<\/span><\/p>\n

\u00a0 “State”: “Confirmed”,<\/span><\/p>\n

\u00a0 “Status”: “1”,<\/span><\/p>\n

\u00a0 “Error”: “”<\/span><\/p>\n

}<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][\/et_pb_accordion][et_pb_text module_id=”CreateOAuthClient” _builder_version=”4.20.0″ text_font=”Nunito Sans||||||||” text_text_color=”#959baf” text_font_size=”18px” text_line_height=”1.8em” header_font=”||||||||” header_2_font=”Nunito Sans|700|||||||” header_2_text_color=”#535b7c” header_2_font_size=”35px” header_2_line_height=”1.3em” header_3_font=”Nunito Sans|700|||||||” header_3_text_color=”#535b7c” header_3_font_size=”25px” header_3_line_height=”1.3em” max_width=”700px” module_alignment=”center” global_colors_info=”{}”]<\/p>\n

6 – Create OAuth Client<\/h3>\n

[\/et_pb_text][et_pb_accordion open_toggle_background_color=”#ffffff” closed_toggle_background_color=”#ffffff” icon_color=”rgba(83,91,124,0.4)” _builder_version=”4.20.0″ toggle_text_color=”#535b7c” toggle_level=”h3″ toggle_font=”Roboto Mono|700|||||||” toggle_text_align=”left” toggle_font_size=”18px” body_font=”Roboto Mono||||||||” body_text_color=”#989db0″ body_font_size=”13px” custom_margin=”||100px|” custom_padding=”|||” border_radii=”on|4px|4px|4px|4px” border_width_all=”0px” border_color_all=”#d9d9d9″ border_style_all=”solid” box_shadow_style=”preset3″ box_shadow_color=”rgba(34,56,101,0.12)” use_border_color=”on” border_width=”0px” global_colors_info=”{}”][et_pb_accordion_item title=”Description” open=”on” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}”]<\/p>\n

To create client ID for Oauth API Integration<\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Resource URL” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

https:\/\/{BaseURL}\/createOAuthClient?ns={{namespace}}<\/a><\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”createOAuthClient Request” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n\n\n\n\n\n\n
Name<\/span><\/td>\nType<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n<\/thead>\n
ClientID<\/span><\/td>\nstring<\/span><\/td>\nThe ClientID is a public identifier for apps<\/span><\/td>\n<\/tr>\n
Expiry<\/span><\/td>\nstring<\/span><\/td>\nAccess Token expiring date<\/span><\/td>\n<\/tr>\n
Merchant<\/span><\/td>\nstring<\/span><\/td>\nMerchant name<\/span><\/td>\n<\/tr>\n
Scope<\/span><\/td>\nstring<\/span><\/td>\n\n

The scope of the access request<\/span><\/p>\n

Example: read, write<\/span><\/p>\n<\/td>\n<\/tr>\n

Secret<\/span><\/td>\nstring<\/span><\/td>\nThe client secret is a secret known only to the application and the authorization server.<\/span><\/td>\n<\/tr>\n
Whitelist<\/span><\/td>\nstring<\/span><\/td>\nAccess control list<\/span><\/td>\n<\/tr>\n
Metadata<\/span><\/td>\nstring<\/span><\/td>\n\n

Any other detail that the merchant wishes to store on this transaction<\/span><\/p>\n

Example: Teller name<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Request Header” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

Authorization: {{bearertoken}} <\/span><\/p>\n

Content-Type: application\/json<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Request Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

{<\/span><\/p>\n

\u00a0\u00a0\u00a0 “ClientID”: “Client1”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “Expiry”: “3600”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “Merchant”: “Merchant1”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “Scope”: “root:all”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “Secret”: “8vxnURAWj0RIbrck6z85DkC8RwtWnmuekFyz18epYRNoiXSpxNh”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “Whitelist”: “*”, \/\/ comma-delimited list<\/span><\/p>\n

“Metadata”: “{\\”ActionID\\”: \\”b37beb5b-e5d5-495c-8525-90b275ff4310\\”}”<\/p>\n

}<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”createOAuthClient Response” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n\n\n\n
Name<\/span><\/td>\nType<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n<\/thead>\n
TID<\/span><\/td>\nstring<\/span><\/td>\n\n

TID (Transaction ID) of the executed API call<\/span><\/p>\n

Example: 1234-5678<\/span><\/p>\n<\/td>\n<\/tr>\n

State<\/span><\/td>\nstring<\/span><\/td>\n\n

Transaction state.<\/span><\/p>\n

Example: Success, Failed<\/span><\/p>\n<\/td>\n<\/tr>\n

Status<\/span><\/td>\nint<\/span><\/td>\n\n

Transaction status.<\/span><\/p>\n

Example: 1 for success<\/span><\/p>\n<\/td>\n<\/tr>\n

Error<\/span><\/td>\nstring<\/span><\/td>\n\n

Failure reason if applicable as notated.<\/span><\/p>\n

Example: Insufficient funds<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

 <\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Response Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

{<\/span><\/p>\n

\u00a0 “TID”: “9636209172”,<\/span><\/p>\n

\u00a0 “State”: “Success”,<\/span><\/p>\n

\u00a0 “Status”: “1”,<\/span><\/p>\n

\u00a0 “Error”: “”<\/span><\/p>\n

}<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][\/et_pb_accordion][et_pb_text module_id=”CreateUser” _builder_version=”4.20.0″ text_font=”Nunito Sans||||||||” text_text_color=”#959baf” text_font_size=”18px” text_line_height=”1.8em” header_font=”||||||||” header_2_font=”Nunito Sans|700|||||||” header_2_text_color=”#535b7c” header_2_font_size=”35px” header_2_line_height=”1.3em” header_3_font=”Nunito Sans|700|||||||” header_3_text_color=”#535b7c” header_3_font_size=”25px” header_3_line_height=”1.3em” max_width=”700px” module_alignment=”center” global_colors_info=”{}”]<\/p>\n

7 – Create User<\/h3>\n

[\/et_pb_text][et_pb_accordion open_toggle_background_color=”#ffffff” closed_toggle_background_color=”#ffffff” icon_color=”rgba(83,91,124,0.4)” _builder_version=”4.20.0″ toggle_text_color=”#535b7c” toggle_level=”h3″ toggle_font=”Roboto Mono|700|||||||” toggle_text_align=”left” toggle_font_size=”18px” body_font=”Roboto Mono||||||||” body_text_color=”#989db0″ body_font_size=”13px” custom_margin=”||100px|” custom_padding=”|||” border_radii=”on|4px|4px|4px|4px” border_width_all=”0px” border_color_all=”#d9d9d9″ border_style_all=”solid” box_shadow_style=”preset3″ box_shadow_color=”rgba(34,56,101,0.12)” use_border_color=”on” border_width=”0px” global_colors_info=”{}”][et_pb_accordion_item title=”Description” open=”on” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}”]<\/p>\n

To create an user account on the platform<\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Resource URL” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

https:\/\/{BaseURL}\/createUser?ns={{namespace}}<\/a><\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”createUser Request” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Name<\/span><\/td>\nType<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n<\/thead>\n
Username<\/span><\/td>\nstring<\/span><\/td>\nName used for customer\u2019s identification<\/span><\/td>\n<\/tr>\n
IDNumber<\/span><\/td>\nstring<\/span><\/td>\nRSA ID number 13 digit<\/span><\/td>\n<\/tr>\n
Merchant<\/span><\/td>\nstring<\/span><\/td>\nMerchant name<\/span><\/td>\n<\/tr>\n
KYC<\/span><\/td>\nstring<\/span><\/td>\nKnow Your Customer (KYC) limit<\/span><\/td>\n<\/tr>\n
Status<\/span><\/td>\nstring<\/span><\/td>\n\n

KYC status<\/span><\/p>\n

Example: ‘Open’, ‘Blocked’ or ‘Closed’<\/span><\/p>\n<\/td>\n<\/tr>\n

DisplayName<\/span><\/td>\nstring<\/span><\/td>\nHow customer\u2019s name is known in the platform<\/span><\/td>\n<\/tr>\n
FirstName<\/span><\/td>\nstring<\/span><\/td>\nCustomer\u2019s first name<\/span><\/td>\n<\/tr>\n
LastName<\/span><\/td>\nString<\/span><\/td>\nCustomer\u2019s last name<\/span><\/td>\n<\/tr>\n
MSISDN<\/span><\/td>\nstring<\/span><\/td>\nCustomer\u2019s mobile number<\/span><\/td>\n<\/tr>\n
Email<\/span><\/td>\nstring<\/span><\/td>\nCustomer\u2019s account<\/span><\/td>\n<\/tr>\n
Currency<\/span><\/td>\nstring<\/span><\/td>\nDefault currency of merchant Example: ZAR (ISO 4217 Currency Codes)<\/span><\/td>\n<\/tr>\n
HouseNumber<\/span><\/td>\nstring<\/span><\/td>\nCustomer\u2019s home number<\/span><\/td>\n<\/tr>\n
StreetName<\/span><\/td>\nstring<\/span><\/td>\nCustomer\u2019s street number<\/span><\/td>\n<\/tr>\n
Suburb<\/span><\/td>\nstring<\/span><\/td>\nCustomer\u2019s Suburb name<\/span><\/td>\n<\/tr>\n
Town<\/span><\/td>\nstring<\/span><\/td>\nCustomer\u2019s city name<\/span><\/td>\n<\/tr>\n
Province<\/span><\/td>\nstring<\/span><\/td>\nCustomer\u2019s province name<\/span><\/td>\n<\/tr>\n
AccountName<\/span><\/td>\nstring<\/span><\/td>\nCustomer\u2019s bank account display name<\/span><\/td>\n<\/tr>\n
AccountNumber<\/span><\/td>\nstring<\/span><\/td>\nCustomer\u2019s bank account number<\/span><\/td>\n<\/tr>\n
AccountType<\/span><\/td>\nstring<\/span><\/td>\nCustomer\u2019s bank account type<\/span><\/td>\n<\/tr>\n
BankName<\/span><\/td>\nstring<\/span><\/td>\nBank name<\/span><\/td>\n<\/tr>\n
BranchCode<\/span><\/td>\nstring<\/span><\/td>\nBank branch code<\/span><\/td>\n<\/tr>\n
Commission<\/span><\/td>\nstring<\/span><\/td>\nCommission rate fee<\/span><\/td>\n<\/tr>\n
CommercialRegistrationNumber<\/span><\/td>\nstring<\/span><\/td>\nCommercial Registration number<\/span><\/td>\n<\/tr>\n
TaxNumber<\/span><\/td>\nstring<\/span><\/td>\nSARS tax number<\/span><\/td>\n<\/tr>\n
Metadata<\/span><\/td>\nstring<\/span><\/td>\n\n

Any other detail that the merchant wishes to store on this transaction<\/span><\/p>\n

Example: Teller name<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Request Header” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

Authorization: {{bearertoken}} <\/span><\/p>\n

Content-Type: application\/json<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Request Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

{<\/span><\/p>\n

\u00a0\u00a0\u00a0 \/\/ User<\/span><\/p>\n

\u00a0\u00a0\u00a0 “Username”: “Merchant1”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “IDNumber”: “”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “KYC”: “0”, \/\/ ‘0’ (no limits) or ‘1’ (limits)<\/span><\/p>\n

\u00a0\u00a0\u00a0 “Status”: “Open”, \/\/ ‘Open’, ‘Blocked’ or ‘Closed’<\/span><\/p>\n

\u00a0\u00a0\u00a0 \/\/ Personal<\/span><\/p>\n

\u00a0\u00a0\u00a0 “DisplayName”: “Store Centurion”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “FirstName”: “John”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “LastName”: “Mercantile”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “MSISDN”: “0648503047”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “Email”: “john@mercantile.com”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “Currency”: “ZAR”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 \/\/ Address<\/span><\/p>\n

\u00a0\u00a0\u00a0 “HouseNumber”: “101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “StreetName”: “Clark Ave”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “Suburb”: “Centurion”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “Town”: “Pretoria”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “Province”: “Gauteng”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 \/\/ Bank<\/span><\/p>\n

\u00a0\u00a0\u00a0 “AccountName”: “MR J M”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “AccountNumber”: “6288854619854”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “AccountType”: “Savings”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “BankName”: “FNB”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “BranchCode”: “265005”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 \/\/ Commercial<\/span><\/p>\n

\u00a0\u00a0\u00a0 “Commission”: “3.0”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “CommercialRegistrationNumber”: “754189057”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TaxNumber”: “255700077”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 <\/span>“Metadata”: “{\\”ActionID\\”: \\”b37beb5b-e5d5-495c-8525-90b275ff4310\\”}”<\/p>\n

}<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”createUser Response” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n\n\n\n\n
Name<\/span><\/td>\nType<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n<\/thead>\n
TID<\/span><\/td>\nstring<\/span><\/td>\n\n

TID (Transaction ID) of the executed API call<\/span><\/p>\n

Example: 1234-5678<\/span><\/p>\n<\/td>\n<\/tr>\n

Reference<\/span><\/td>\nstring<\/span><\/td>\n\n

A unique transaction reference number given by the merchant.<\/span><\/p>\n

Example: 101<\/span><\/p>\n<\/td>\n<\/tr>\n

State<\/span><\/td>\nstring<\/span><\/td>\n\n

Transaction state.<\/span><\/p>\n

Example: Success, Failed<\/span><\/p>\n<\/td>\n<\/tr>\n

Status<\/span><\/td>\nint<\/span><\/td>\n\n

Transaction status.<\/span><\/p>\n

Example: 1 for success<\/span><\/p>\n<\/td>\n<\/tr>\n

Error<\/span><\/td>\nstring<\/span><\/td>\n\n

Failure reason if applicable as notated.<\/span><\/p>\n

Example: Insufficient funds<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Response Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

{<\/span><\/p>\n

\u00a0 “TID”: “9636209172”,<\/span><\/p>\n

\u00a0 “Reference”: “1707385761”,<\/span><\/p>\n

\u00a0 “Created”: “2020\/12\/01 17:23”,<\/span><\/p>\n

\u00a0 “Amount”: “250”,<\/span><\/p>\n

\u00a0 “State”: “Success”,<\/span><\/p>\n

\u00a0 “Status”: “1”,<\/span><\/p>\n

\u00a0 “Error”: “”<\/span><\/p>\n

}<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][\/et_pb_accordion][et_pb_text module_id=”CreateVoucher” _builder_version=”4.20.0″ text_font=”Nunito Sans||||||||” text_text_color=”#959baf” text_font_size=”18px” text_line_height=”1.8em” header_font=”||||||||” header_2_font=”Nunito Sans|700|||||||” header_2_text_color=”#535b7c” header_2_font_size=”35px” header_2_line_height=”1.3em” header_3_font=”Nunito Sans|700|||||||” header_3_text_color=”#535b7c” header_3_font_size=”25px” header_3_line_height=”1.3em” max_width=”700px” module_alignment=”center” global_colors_info=”{}”]<\/p>\n

8 – Create Voucher<\/h3>\n

[\/et_pb_text][et_pb_accordion open_toggle_background_color=”#ffffff” closed_toggle_background_color=”#ffffff” icon_color=”rgba(83,91,124,0.4)” _builder_version=”4.20.0″ toggle_text_color=”#535b7c” toggle_level=”h3″ toggle_font=”Roboto Mono|700|||||||” toggle_text_align=”left” toggle_font_size=”18px” body_font=”Roboto Mono||||||||” body_text_color=”#989db0″ body_font_size=”13px” custom_margin=”||100px|” custom_padding=”|||” border_radii=”on|4px|4px|4px|4px” border_width_all=”0px” border_color_all=”#d9d9d9″ border_style_all=”solid” box_shadow_style=”preset3″ box_shadow_color=”rgba(34,56,101,0.12)” use_border_color=”on” border_width=”0px” global_colors_info=”{}”][et_pb_accordion_item title=”Description” open=”on” _builder_version=”4.20.0″ global_colors_info=”{}”]<\/p>\n

This call is used to create a single voucher and disburse to a user.<\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” Resource URL” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

https:\/\/{BaseURL}\/createvoucher?ns={{namespace}}<\/a><\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” CreateVoucherRequest” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n\n\n\n\n\n\n
Name<\/span><\/td>\nType<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n<\/thead>\n
VoucherType<\/span><\/td>\nstring<\/span><\/td>\n\n

Name of the voucher type<\/span><\/p>\n

Example: Book, Cash<\/span><\/p>\n<\/td>\n<\/tr>\n

MSISDN<\/span><\/td>\nstring<\/span><\/td>\nCellphone number receiving the voucher Example: 27820000000<\/span><\/td>\n<\/tr>\n
Reference<\/span><\/td>\nstring<\/span><\/td>\nA unique transaction reference number given by the merchant** Example: 101<\/span><\/td>\n<\/tr>\n
Amount<\/span><\/td>\nint<\/span><\/td>\nTransaction amount in cents Example: 2000 (R 20.00)<\/span><\/td>\n<\/tr>\n
Currency<\/span><\/td>\nstring<\/span><\/td>\nDefault is currency of merchant Example: ZAR (ISO 4217 Currency Codes)<\/span><\/td>\n<\/tr>\n
StoreID<\/span><\/td>\nstring<\/span><\/td>\n\n

A unique store identifier code – Source of the funds<\/span><\/p>\n

Example: 12345<\/span><\/p>\n<\/td>\n<\/tr>\n

Metadata<\/span><\/td>\nstring<\/span><\/td>\nAny other detail that the merchant wishes to store on this transaction Example: Teller name<\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” Request Header” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

Authorization: {{bearertoken}}<\/span><\/p>\n

Content-Type: application\/json<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” Request Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

{<\/span><\/p>\n

\u00a0 “Amount”: “10000”,<\/span><\/p>\n

\u00a0 “Currency”: “ZAR”,<\/span><\/p>\n

\u00a0 “MSISDN”: “Merchant1”,<\/span><\/p>\n

\u00a0 “StoreID”: “Celbux”,<\/span><\/p>\n

\u00a0 “VoucherType”: “Book”,<\/span><\/p>\n

\u00a0 “Reference”: “{{$timestamp}}”,<\/span><\/p>\n

“Metadata”: “{\\”ActionID\\”: \\”b37beb5b-e5d5-495c-8525-90b275ff4310\\”}”<\/p>\n

}<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”CreateVoucher Response” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Name<\/span><\/td>\nType<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n<\/thead>\n
TID<\/span><\/td>\nString<\/span><\/td>\n\n

TID (Transaction ID) of the executed API call<\/span><\/p>\n

Example: 1234-5678<\/span><\/p>\n<\/td>\n<\/tr>\n

VoucherNo<\/span><\/td>\nstring<\/span><\/td>\n\n

A valid voucher number <\/span><\/p>\n

Example: 228 00000 00000<\/span><\/p>\n<\/td>\n<\/tr>\n

VID<\/span><\/td>\nString<\/span><\/td>\nVoucher ID. Example: 2628857436<\/span><\/td>\n<\/tr>\n
Reference<\/span><\/td>\nstring<\/span><\/td>\nA unique transaction reference number given by the merchant Example: 101<\/span><\/td>\n<\/tr>\n
Created<\/span><\/td>\nstring<\/span><\/td>\n\n

Transaction execution time <\/span><\/p>\n

Example: 2013\/01\/01 12:00<\/span><\/p>\n<\/td>\n<\/tr>\n

Amount<\/span><\/td>\nint<\/span><\/td>\nTransaction amount in cents Example: 2000 (R 20.00)<\/span><\/td>\n<\/tr>\n
State<\/span><\/td>\nstring<\/span><\/td>\n\n

Transaction state <\/span><\/p>\n

Example: Success, failed<\/span><\/p>\n<\/td>\n<\/tr>\n

Status<\/span><\/td>\nint<\/span><\/td>\n\n

Transaction status <\/span><\/p>\n

Example: 1 for success<\/span><\/p>\n<\/td>\n<\/tr>\n

Error<\/span><\/td>\nstring<\/span><\/td>\nFailure reason if applicable as notated Example: Insufficient funds<\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” Response Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

{<\/span><\/p>\n

\u00a0 “VoucherNo”: “”,<\/span><\/p>\n

\u00a0 “Reference”: “1629965167”,<\/span><\/p>\n

\u00a0 “Created”: “2021\/08\/26 08:06”,<\/span><\/p>\n

\u00a0 “Amount”: “1000”,<\/span><\/p>\n

\u00a0 “State”: “Success”,<\/span><\/p>\n

\u00a0 “Status”: “1”,<\/span><\/p>\n

\u00a0 “Error”: “”,<\/span><\/p>\n

\u00a0 “VID”: “2628857436”,<\/span><\/p>\n

\u00a0 “TID”: “9804699185”<\/span><\/p>\n

}<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][\/et_pb_accordion][et_pb_text module_id=”CreateVoucherType” _builder_version=”4.20.0″ text_font=”Nunito Sans||||||||” text_text_color=”#959baf” text_font_size=”18px” text_line_height=”1.8em” header_font=”||||||||” header_2_font=”Nunito Sans|700|||||||” header_2_text_color=”#535b7c” header_2_font_size=”35px” header_2_line_height=”1.3em” header_3_font=”Nunito Sans|700|||||||” header_3_text_color=”#535b7c” header_3_font_size=”25px” header_3_line_height=”1.3em” max_width=”700px” module_alignment=”center” global_colors_info=”{}”]<\/p>\n

9 – CreateVoucherType<\/h3>\n

[\/et_pb_text][et_pb_accordion open_toggle_background_color=”#ffffff” closed_toggle_background_color=”#ffffff” icon_color=”rgba(83,91,124,0.4)” _builder_version=”4.20.0″ toggle_text_color=”#535b7c” toggle_level=”h3″ toggle_font=”Roboto Mono|700|||||||” toggle_text_align=”left” toggle_font_size=”18px” body_font=”Roboto Mono||||||||” body_text_color=”#989db0″ body_font_size=”13px” custom_margin=”||100px|” custom_padding=”|||” border_radii=”on|4px|4px|4px|4px” border_width_all=”0px” border_color_all=”#d9d9d9″ border_style_all=”solid” box_shadow_style=”preset3″ box_shadow_color=”rgba(34,56,101,0.12)” use_border_color=”on” border_width=”0px” global_colors_info=”{}”][et_pb_accordion_item title=” Description” open=”on” _builder_version=”4.20.0″ global_colors_info=”{}”]<\/p>\n

This call is used to create a voucher type.<\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” Resource URL” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

https:\/\/{BaseURL}\/createVoucherType?ns={{namespace}}<\/a><\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” CreateVoucherRequest” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Name<\/span><\/td>\nType<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n<\/thead>\n
AutoLock<\/span><\/td>\nstring<\/span><\/td>\n\n

Controls whether the voucher is relocked automatically on-spend<\/span><\/p>\n

Example: 1 or empty field<\/span><\/p>\n<\/td>\n<\/tr>\n

Locked<\/span><\/td>\nstring<\/span><\/td>\n\n

Controls whether new vouchers are locked by default<\/span><\/p>\n

Example: 1 or empty field<\/span><\/p>\n<\/td>\n<\/tr>\n

PIN<\/span><\/td>\nstring<\/span><\/td>\nAny value; The PIN of the voucher must be empty to spend, via \/updateVoucher (meaning PIN validation must be done externally before clearing it via API)<\/span><\/td>\n<\/tr>\n
ThirdParty<\/span><\/td>\nint<\/span><\/td>\nAny value (usually MSISDN); The ThirdPartyClear field of the voucher must match the value placed here, via \/updateVoucher<\/span><\/td>\n<\/tr>\n
VAccumulate<\/span><\/td>\nstring<\/span><\/td>\n\n

Controls whether new vouchers of this type are accumulated, or created standalone alongside each other<\/span><\/p>\n

Example: 1 or empty field<\/span><\/p>\n<\/td>\n<\/tr>\n

VMetadata<\/span><\/td>\n\u00a0<\/span><\/td>\nThe transaction must NOT include alcohol anywhere, and must contain merchant_name somewhere<\/span><\/td>\n<\/tr>\n
VoucherType<\/span><\/td>\n\u00a0<\/span><\/td>\n\n

Name of the voucher type<\/span><\/p>\n

Example: Book, Cash<\/span><\/p>\n<\/td>\n<\/tr>\n

VSettle<\/span><\/td>\n\u00a0<\/span><\/td>\n\n

Controls whether the voucher can be settled into the user’s cash balance<\/span><\/p>\n

Example: 1 or empty field<\/span><\/p>\n<\/td>\n<\/tr>\n

WithdrawFee<\/span><\/td>\nstring<\/span><\/td>\n\n

Amount in cents that it costs to withdraw this voucher as cash<\/span><\/p>\n

Example: 900<\/span><\/p>\n<\/td>\n<\/tr>\n

Metadata<\/span><\/td>\nstring<\/span><\/td>\nAny other detail that the merchant wishes to store on this transaction Example: Teller name<\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” Request Header” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

Authorization: {{bearertoken}}<\/span><\/p>\n

Content-Type: application\/json<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” Request Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

{<\/span><\/p>\n

\u00a0\u00a0\u00a0 “AutoLock”: “”, <\/span><\/p>\n

\u00a0\u00a0\u00a0 “Locked”: “”, <\/span><\/p>\n

\u00a0\u00a0\u00a0 “PIN”: “”, <\/span><\/p>\n

\u00a0\u00a0\u00a0 “ThirdParty”: <\/span><\/p>\n

\u00a0\u00a0\u00a0 “VAccumulate”: “1\u201d,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “VMetadata”: “Contains![alcohol] Contains[merchant_name]”, <\/span><\/p>\n

\u00a0\u00a0\u00a0 “VoucherType”: “Book”, <\/span><\/p>\n

\u00a0\u00a0\u00a0 “VSettle”: “”, <\/span><\/p>\n

\u00a0\u00a0\u00a0 “WithdrawFee”: “900”, <\/span><\/p>\n

“Metadata”: “{\\”ActionID\\”: \\”b37beb5b-e5d5-495c-8525-90b275ff4310\\”}”<\/p>\n

}<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” CreateVoucherType Response” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n\n\n\n
Name<\/span><\/td>\nType<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n<\/thead>\n
TID<\/span><\/td>\nstring<\/span><\/td>\n\n

TID (Transaction ID) of the executed API call<\/span><\/p>\n

Example: 1234-5678<\/span><\/p>\n<\/td>\n<\/tr>\n

State<\/span><\/td>\nstring<\/span><\/td>\n\n

Transaction state <\/span><\/p>\n

Example: Success, failed<\/span><\/p>\n<\/td>\n<\/tr>\n

Status<\/span><\/td>\nint<\/span><\/td>\n\n

Transaction status <\/span><\/p>\n

Example: 1 for success<\/span><\/p>\n<\/td>\n<\/tr>\n

Error<\/span><\/td>\nstring<\/span><\/td>\nFailure reason if applicable as notated Example: Insufficient funds<\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” Response Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

{<\/span><\/p>\n

\u00a0 “State”: “Success”,<\/span><\/p>\n

\u00a0 “Status”: “1”,<\/span><\/p>\n

\u00a0 “Error”: “”,<\/span><\/p>\n

\u00a0 “TID”: “9804699185”<\/span><\/p>\n

}<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][\/et_pb_accordion][et_pb_text module_id=”LinkMerchant” _builder_version=”4.20.0″ text_font=”Nunito Sans||||||||” text_text_color=”#959baf” text_font_size=”18px” text_line_height=”1.8em” header_font=”||||||||” header_2_font=”Nunito Sans|700|||||||” header_2_text_color=”#535b7c” header_2_font_size=”35px” header_2_line_height=”1.3em” header_3_font=”Nunito Sans|700|||||||” header_3_text_color=”#535b7c” header_3_font_size=”25px” header_3_line_height=”1.3em” max_width=”700px” module_alignment=”center” global_colors_info=”{}”]<\/p>\n

10 – Link Merchant<\/h3>\n

[\/et_pb_text][et_pb_accordion open_toggle_background_color=”#ffffff” closed_toggle_background_color=”#ffffff” icon_color=”rgba(83,91,124,0.4)” _builder_version=”4.20.0″ toggle_text_color=”#535b7c” toggle_level=”h3″ toggle_font=”Roboto Mono|700|||||||” toggle_text_align=”left” toggle_font_size=”18px” body_font=”Roboto Mono||||||||” body_text_color=”#989db0″ body_font_size=”13px” custom_margin=”||100px|” custom_padding=”|||” border_radii=”on|4px|4px|4px|4px” border_width_all=”0px” border_color_all=”#d9d9d9″ border_style_all=”solid” box_shadow_style=”preset3″ box_shadow_color=”rgba(34,56,101,0.12)” use_border_color=”on” border_width=”0px” global_colors_info=”{}”][et_pb_accordion_item title=” Description” open=”on” _builder_version=”4.20.0″ global_colors_info=”{}”]<\/p>\n

This call is used to link a voucher type to a merchant account<\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” Resource URL” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

https:\/\/{BaseURL}\/linkMerchant?ns={{namespace}}<\/a><\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” linkMerchant Request” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n\n\n
Name<\/span><\/td>\nType<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n<\/thead>\n
Merchant<\/span><\/td>\nstring<\/span><\/td>\nMerchant name<\/span><\/td>\n<\/tr>\n
VoucherType<\/span><\/td>\nstring<\/span><\/td>\n\n

Name of the voucher type<\/span><\/p>\n

Example: Book, Cash<\/span><\/p>\n<\/td>\n<\/tr>\n

Metadata<\/span><\/td>\nstring<\/span><\/td>\nAny other detail that the merchant wishes to store on this transaction Example: Teller name<\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” Request Header” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

Authorization: {{bearertoken}}<\/span><\/p>\n

Content-Type: application\/json<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” Request Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

{<\/span><\/p>\n

\u00a0\u00a0\u00a0 “Merchant”: “Merchant1”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “VoucherType”: “Flash”,<\/span><\/p>\n

“Metadata”: “{\\”ActionID\\”: \\”b37beb5b-e5d5-495c-8525-90b275ff4310\\”}”<\/p>\n

}<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” LinkMerchant Response” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n\n\n\n
Name<\/span><\/td>\nType<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n<\/thead>\n
TID<\/span><\/td>\nint<\/span><\/td>\n\n

TID (Transaction ID) of the executed API call<\/span><\/p>\n

Example: 1234-5678<\/span><\/p>\n<\/td>\n<\/tr>\n

State<\/span><\/td>\nstring<\/span><\/td>\nTransaction state Example: Success, failed<\/span><\/td>\n<\/tr>\n
Status<\/span><\/td>\nint<\/span><\/td>\nTransaction status Example: 1 for success<\/span><\/td>\n<\/tr>\n
Error<\/span><\/td>\nstring<\/span><\/td>\nFailure reason if applicable as notated Example: Insufficient funds<\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” Response Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

{<\/span><\/p>\n

\u00a0“TID”: “9804699185”<\/span><\/p>\n

\u00a0“State”: “Success”,<\/span><\/p>\n

\u00a0 “Status”: “1”,<\/span><\/p>\n

\u00a0 “Error”: “”,<\/span><\/p>\n

}<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][\/et_pb_accordion][et_pb_text module_id=”ReadActionHistory” _builder_version=”4.20.0″ text_font=”Nunito Sans||||||||” text_text_color=”#959baf” text_font_size=”18px” text_line_height=”1.8em” header_font=”||||||||” header_2_font=”Nunito Sans|700|||||||” header_2_text_color=”#535b7c” header_2_font_size=”35px” header_2_line_height=”1.3em” header_3_font=”Nunito Sans|700|||||||” header_3_text_color=”#535b7c” header_3_font_size=”25px” header_3_line_height=”1.3em” max_width=”700px” module_alignment=”center” global_colors_info=”{}”]<\/p>\n

11 – Read Action History<\/h3>\n

[\/et_pb_text][et_pb_accordion open_toggle_background_color=”#ffffff” closed_toggle_background_color=”#ffffff” icon_color=”rgba(83,91,124,0.4)” _builder_version=”4.20.0″ toggle_text_color=”#535b7c” toggle_level=”h3″ toggle_font=”Roboto Mono|700|||||||” toggle_text_align=”left” toggle_font_size=”18px” body_font=”Roboto Mono||||||||” body_text_color=”#989db0″ body_font_size=”13px” custom_margin=”||100px|” custom_padding=”|||” border_radii=”on|4px|4px|4px|4px” border_width_all=”0px” border_color_all=”#d9d9d9″ border_style_all=”solid” box_shadow_style=”preset3″ box_shadow_color=”rgba(34,56,101,0.12)” use_border_color=”on” border_width=”0px” global_colors_info=”{}”][et_pb_accordion_item title=” Description” open=”on” _builder_version=”4.20.0″ global_colors_info=”{}”]<\/p>\n

This call is used to read actions that succeeded on the platform.<\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” Resource URL” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

https:\/\/{BaseURL}\/actionhistory\/read?ns={{namespace}}<\/a><\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” actionhistory\/read Request” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n\n\n\n
Name<\/span><\/td>\nType<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n<\/thead>\n
ActionID<\/span><\/td>\nstring<\/span><\/td>\nPiece of data populated into API call\u2019s metadata<\/span><\/td>\n<\/tr>\n
DateFrom<\/span><\/td>\nstring<\/span><\/td>\n\n

Time from.<\/span><\/p>\n

Example Values: 2018\/01\/01 12:00<\/span><\/p>\n<\/td>\n<\/tr>\n

DateTo<\/span><\/td>\nstring<\/span><\/td>\n\n

Time to.<\/span><\/p>\n

Example Values: 2018\/01\/02 16:00<\/span><\/p>\n<\/td>\n<\/tr>\n

Limit<\/span><\/td>\ninr<\/span><\/td>\nAn Integer to limit the quantity of responses.<\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

 <\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” Request Header” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

Authorization: {{bearertoken}}<\/span><\/p>\n

Content-Type: application\/json<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” Request Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

{<\/span><\/p>\n

\u00a0\u00a0\u00a0 “ActionID”: “user~0648503047”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “DateFrom”: “”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “DateTo”: “”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “Limit”: 0<\/span><\/p>\n

}<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

 <\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” actionhistory\/read Response” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n\n\n\n
Name<\/span><\/td>\nType<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n<\/thead>\n
TID<\/span><\/td>\nint<\/span><\/td>\n\n

TID (Transaction ID) of the executed API call<\/span><\/p>\n

Example: 1234-5678<\/span><\/p>\n<\/td>\n<\/tr>\n

State<\/span><\/td>\nstring<\/span><\/td>\n\n

Transaction state <\/span><\/p>\n

Example: Success, failed<\/span><\/p>\n<\/td>\n<\/tr>\n

Status<\/span><\/td>\nint<\/span><\/td>\n\n

Transaction status <\/span><\/p>\n

Example: 1 for success<\/span><\/p>\n<\/td>\n<\/tr>\n

Error<\/span><\/td>\nstring<\/span><\/td>\nFailure reason if applicable as notated Example: Insufficient funds<\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” Response Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

{<\/span><\/p>\n

\u00a0“TID”: “9804699185”,<\/span><\/p>\n

\u00a0 “State”: “Success”,<\/span><\/p>\n

\u00a0 “Status”: “1”,<\/span><\/p>\n

\u00a0 “Error”: “”<\/span><\/p>\n

\u00a0 }<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][\/et_pb_accordion][et_pb_text module_id=”RemoveUsersfromCommunities” _builder_version=”4.20.0″ text_font=”Nunito Sans||||||||” text_text_color=”#959baf” text_font_size=”18px” text_line_height=”1.8em” header_font=”||||||||” header_2_font=”Nunito Sans|700|||||||” header_2_text_color=”#535b7c” header_2_font_size=”35px” header_2_line_height=”1.3em” header_3_font=”Nunito Sans|700|||||||” header_3_text_color=”#535b7c” header_3_font_size=”25px” header_3_line_height=”1.3em” max_width=”700px” module_alignment=”center” global_colors_info=”{}”]<\/p>\n

12 – Remove Users from Communities<\/h3>\n

[\/et_pb_text][et_pb_accordion open_toggle_background_color=”#ffffff” closed_toggle_background_color=”#ffffff” icon_color=”rgba(83,91,124,0.4)” _builder_version=”4.20.0″ toggle_text_color=”#535b7c” toggle_level=”h3″ toggle_font=”Roboto Mono|700|||||||” toggle_text_align=”left” toggle_font_size=”18px” body_font=”Roboto Mono||||||||” body_text_color=”#989db0″ body_font_size=”13px” custom_margin=”||100px|” custom_padding=”|||” border_radii=”on|4px|4px|4px|4px” border_width_all=”0px” border_color_all=”#d9d9d9″ border_style_all=”solid” box_shadow_style=”preset3″ box_shadow_color=”rgba(34,56,101,0.12)” use_border_color=”on” border_width=”0px” global_colors_info=”{}”][et_pb_accordion_item title=” Description” open=”on” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}”]<\/p>\n

This call is used to remove users’ accounts from one or more communities<\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” Resource URL” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

https:\/\/{BaseURL}\/removeUsersFromCommunities?ns={{namespace}}<\/a><\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” removeUsersFromCommunities Request” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n\n\n
Name<\/span><\/td>\nType<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n<\/thead>\n
MSISDNs<\/span><\/td>\nstring<\/span><\/td>\nList of user accounts <\/span><\/td>\n<\/tr>\n
Communities<\/span><\/td>\nstring<\/span><\/td>\nList of communities<\/span><\/td>\n<\/tr>\n
Metadata<\/span><\/td>\nstring<\/span><\/td>\nAny other detail that the merchant wishes to store on this transaction Example: Teller name<\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” Request Header” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

Authorization: {{bearertoken}}<\/span><\/p>\n

Content-Type: application\/json<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” Request Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

{<\/span><\/p>\n

\u00a0\u00a0\u00a0 “MSISDNs”: “Merchant1”, \/\/ comma-delimited list<\/span><\/p>\n

\u00a0\u00a0\u00a0 “Communities”: “celbux101”, \/\/ comma-delimited list<\/span><\/p>\n

“Metadata”: “{\\”ActionID\\”: \\”b37beb5b-e5d5-495c-8525-90b275ff4310\\”}”<\/p>\n

}<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” removeUsersFromCommunities Response” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n\n\n\n
Name<\/span><\/td>\nType<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n<\/thead>\n
TID<\/span><\/td>\nint<\/span><\/td>\n\n

TID (Transaction ID) of the executed API call<\/span><\/p>\n

Example: 1234-5678<\/span><\/p>\n<\/td>\n<\/tr>\n

State<\/span><\/td>\nstring<\/span><\/td>\n\n

Transaction state <\/span><\/p>\n

Example: Success, failed<\/span><\/p>\n<\/td>\n<\/tr>\n

Status<\/span><\/td>\nint<\/span><\/td>\n\n

Transaction status <\/span><\/p>\n

Example: 1 for success<\/span><\/p>\n<\/td>\n<\/tr>\n

Error<\/span><\/td>\nstring<\/span><\/td>\nFailure reason if applicable as notated Example: Insufficient funds<\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” Response Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

{<\/span><\/p>\n

\u00a0“TID”: “9804699185”,<\/span><\/p>\n

\u00a0 “State”: “Success”,<\/span><\/p>\n

\u00a0 “Status”: “1”,<\/span><\/p>\n

\u00a0 “Error”: “”,<\/span><\/p>\n

\u00a0 }<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][\/et_pb_accordion][et_pb_text module_id=”ResetPassword” _builder_version=”4.20.0″ text_font=”Nunito Sans||||||||” text_text_color=”#959baf” text_font_size=”18px” text_line_height=”1.8em” header_font=”||||||||” header_2_font=”Nunito Sans|700|||||||” header_2_text_color=”#535b7c” header_2_font_size=”35px” header_2_line_height=”1.3em” header_3_font=”Nunito Sans|700|||||||” header_3_text_color=”#535b7c” header_3_font_size=”25px” header_3_line_height=”1.3em” max_width=”700px” module_alignment=”center” global_colors_info=”{}”]<\/p>\n

13 – Reset Password<\/h3>\n

[\/et_pb_text][et_pb_accordion open_toggle_background_color=”#ffffff” closed_toggle_background_color=”#ffffff” icon_color=”rgba(83,91,124,0.4)” _builder_version=”4.20.0″ toggle_text_color=”#535b7c” toggle_level=”h3″ toggle_font=”Roboto Mono|700|||||||” toggle_text_align=”left” toggle_font_size=”18px” body_font=”Roboto Mono||||||||” body_text_color=”#989db0″ body_font_size=”13px” custom_margin=”||100px|” custom_padding=”|||” border_radii=”on|4px|4px|4px|4px” border_width_all=”0px” border_color_all=”#d9d9d9″ border_style_all=”solid” box_shadow_style=”preset3″ box_shadow_color=”rgba(34,56,101,0.12)” use_border_color=”on” border_width=”0px” global_colors_info=”{}”][et_pb_accordion_item title=”6.10 Description” open=”on” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}”]<\/p>\n

This call is used to reset the user’s password<\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”6.11 Resource URL” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

https:\/\/{BaseURL}\/resetPassword?ns={{namespace}}<\/a><\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”6.12 ResetPassword Request” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n\n\n\n\n
\n

Name<\/span><\/p>\n<\/td>\n

\n

Type<\/span><\/p>\n<\/td>\n

\n

Description<\/span><\/p>\n<\/td>\n<\/tr>\n<\/thead>\n

\n

MSISDN<\/span><\/p>\n<\/td>\n

\n

string<\/span><\/p>\n<\/td>\n

\n

Customer\u2019s mobile number <\/span><\/p>\n<\/td>\n<\/tr>\n

\n

IDNumber<\/span><\/p>\n<\/td>\n

\n

string<\/span><\/p>\n<\/td>\n

\n

RSA ID number 13 digit<\/span><\/p>\n<\/td>\n<\/tr>\n

\n

OTP<\/span><\/p>\n<\/td>\n

\n

string<\/span><\/p>\n<\/td>\n

\n

One Time Pin number<\/span><\/p>\n<\/td>\n<\/tr>\n

\n

Reference<\/span><\/p>\n<\/td>\n

\n

string<\/span><\/p>\n<\/td>\n

\n

A unique transaction reference number given by the merchant<\/span><\/p>\n<\/td>\n<\/tr>\n

\n

Metadata<\/span><\/p>\n<\/td>\n

\n

string<\/span><\/p>\n<\/td>\n

\n

Any other detail that the merchant wishes to store on this transaction Example: Teller name<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”6.12.1 Request Header” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

Authorization: {{bearertoken}}<\/span><\/p>\n

Content-Type: application\/json<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”6.12.2 Request Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

{<\/span><\/p>\n

\u00a0\u00a0\u00a0 “MSISDN”: “27648503049”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “IDNumber”: “0107255802087”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “OTP”: “602734”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “Reference”: “{{$timestamp}}”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “Metadata”: “{\\”ActionID\\”: \\”b37beb5b-e5d5-495c-8525-90b275ff4310\\”}”<\/p>\n

}<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”6.13 ResetPassword Response” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n\n\n\n\n
\n

Name<\/span><\/p>\n<\/td>\n

\n

Type<\/span><\/p>\n<\/td>\n

\n

Description<\/span><\/p>\n<\/td>\n<\/tr>\n<\/thead>\n

\n

TID<\/span><\/p>\n<\/td>\n

\n

string<\/span><\/p>\n<\/td>\n

\n

TID (Transaction ID) of the executed API call<\/span><\/p>\n

Example: 1234-5678<\/span><\/p>\n<\/td>\n<\/tr>\n

\n

Reference<\/span><\/p>\n<\/td>\n

\n

string<\/span><\/p>\n<\/td>\n

\n

A unique transaction reference number given by the merchant Example: 101<\/span><\/p>\n<\/td>\n<\/tr>\n

\n

State<\/span><\/p>\n<\/td>\n

\n

string<\/span><\/p>\n<\/td>\n

\n

Transaction state <\/span><\/p>\n

Example: Success, failed<\/span><\/p>\n<\/td>\n<\/tr>\n

\n

Status<\/span><\/p>\n<\/td>\n

\n

int<\/span><\/p>\n<\/td>\n

\n

Transaction status <\/span><\/p>\n

Example: 1 for success<\/span><\/p>\n<\/td>\n<\/tr>\n

\n

Error<\/span><\/p>\n<\/td>\n

\n

string<\/span><\/p>\n<\/td>\n

\n

Failure reason if applicable as notated Example: Insufficient funds<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”6.13.1 Response Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

{<\/span><\/p>\n

\u00a0 “TID”: “9804699185”<\/span><\/p>\n

\u00a0 “Reference”: “1629965167”,<\/span><\/p>\n

\u00a0 “State”: “Success”,<\/span><\/p>\n

\u00a0 “Status”: “1”,<\/span><\/p>\n

\u00a0 “Error”: “”<\/span><\/p>\n

\u00a0 }<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][\/et_pb_accordion][et_pb_text module_id=”sendotp” _builder_version=”4.20.0″ text_font=”Nunito Sans||||||||” text_text_color=”#959baf” text_font_size=”18px” text_line_height=”1.8em” header_font=”||||||||” header_2_font=”Nunito Sans|700|||||||” header_2_text_color=”#535b7c” header_2_font_size=”35px” header_2_line_height=”1.3em” header_3_font=”Nunito Sans|700|||||||” header_3_text_color=”#535b7c” header_3_font_size=”25px” header_3_line_height=”1.3em” max_width=”700px” module_alignment=”center” global_colors_info=”{}”]<\/p>\n

14 – Send OTP<\/h3>\n

[\/et_pb_text][et_pb_accordion open_toggle_background_color=”#ffffff” closed_toggle_background_color=”#ffffff” icon_color=”rgba(83,91,124,0.4)” _builder_version=”4.20.0″ toggle_text_color=”#535b7c” toggle_level=”h3″ toggle_font=”Roboto Mono|700|||||||” toggle_text_align=”left” toggle_font_size=”18px” body_font=”Roboto Mono||||||||” body_text_color=”#989db0″ body_font_size=”13px” custom_margin=”||100px|” custom_padding=”|||” border_radii=”on|4px|4px|4px|4px” border_width_all=”0px” border_color_all=”#d9d9d9″ border_style_all=”solid” box_shadow_style=”preset3″ box_shadow_color=”rgba(34,56,101,0.12)” use_border_color=”on” border_width=”0px” global_colors_info=”{}”][et_pb_accordion_item title=” Description” open=”on” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}”]<\/p>\n

This call is used to send the OTP to complete the reset password API and change MSISDN API call<\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” Resource URL” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

https:\/\/{BaseURL}\/sendOTP?ns={{namespace}}<\/a><\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” sendOTP Request” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n\n\n\n\n
Name<\/span><\/td>\nType<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n<\/thead>\n
MSISDN<\/span><\/td>\nstring<\/span><\/td>\nCustomer\u2019s mobile number <\/span><\/td>\n<\/tr>\n
IDNumber<\/span><\/td>\nstring<\/span><\/td>\nRSA ID number 13 digit<\/span><\/td>\n<\/tr>\n
NewMSISDN<\/span><\/td>\nstring<\/span><\/td>\nCustomer\u2019s new Mobile number<\/td>\n<\/tr>\n
Reference<\/span><\/td>\nstring<\/span><\/td>\nA unique transaction reference number given by the merchant<\/span><\/td>\n<\/tr>\n
Metadata<\/span><\/td>\nstring<\/span><\/td>\nAny other detail that the merchant wishes to store on this transaction Example: Teller name<\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” Request Header” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

Authorization: {{bearertoken}}<\/span><\/p>\n

Content-Type: application\/json<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” Request Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

{<\/span><\/p>\n

\u00a0\u00a0\u00a0 “OldMSISDN”: “0648503047”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “IDNumber”: “”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “NewMSISDN”: “0648503049”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “OTP”: “437147”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “Reference”: “{{$timestamp}}”,<\/span><\/p>\n

“Metadata”: “{\\”ActionID\\”: \\”b37beb5b-e5d5-495c-8525-90b275ff4310\\”}”<\/p>\n

}<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”SendOtp Response” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n\n\n\n\n
Name<\/span><\/td>\nType<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n<\/thead>\n
TID<\/span><\/td>\nstring<\/span><\/td>\n\n

TID (Transaction ID) of the executed API call<\/span><\/p>\n

Example: 1234-5678<\/span><\/p>\n<\/td>\n<\/tr>\n

Reference<\/span><\/td>\nstring<\/span><\/td>\nA unique transaction reference number given by the merchant Example: 101<\/span><\/td>\n<\/tr>\n
State<\/span><\/td>\nstring<\/span><\/td>\n\n

Transaction state <\/span><\/p>\n

Example: Success, failed<\/span><\/p>\n<\/td>\n<\/tr>\n

Status<\/span><\/td>\nint<\/span><\/td>\n\n

Transaction status <\/span><\/p>\n

Example: 1 for success<\/span><\/p>\n<\/td>\n<\/tr>\n

Error<\/span><\/td>\nstring<\/span><\/td>\nFailure reason if applicable as notated Example: Insufficient funds<\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” Response Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

{<\/span><\/p>\n

\u00a0 “TID”: “9804699185”<\/span><\/p>\n

\u00a0 “Reference”: “1629965167”,<\/span><\/p>\n

\u00a0 “State”: “Success”,<\/span><\/p>\n

\u00a0 “Status”: “1”,<\/span><\/p>\n

\u00a0 “Error”: “”<\/span><\/p>\n

\u00a0}<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][\/et_pb_accordion][et_pb_text module_id=”UnlinkMerchant” _builder_version=”4.20.0″ text_font=”Nunito Sans||||||||” text_text_color=”#959baf” text_font_size=”18px” text_line_height=”1.8em” header_font=”||||||||” header_2_font=”Nunito Sans|700|||||||” header_2_text_color=”#535b7c” header_2_font_size=”35px” header_2_line_height=”1.3em” header_3_font=”Nunito Sans|700|||||||” header_3_text_color=”#535b7c” header_3_font_size=”25px” header_3_line_height=”1.3em” max_width=”700px” module_alignment=”center” global_colors_info=”{}”]<\/p>\n

15 – Unlink Merchant<\/h3>\n

[\/et_pb_text][et_pb_accordion open_toggle_background_color=”#ffffff” closed_toggle_background_color=”#ffffff” icon_color=”rgba(83,91,124,0.4)” _builder_version=”4.20.0″ toggle_text_color=”#535b7c” toggle_level=”h3″ toggle_font=”Roboto Mono|700|||||||” toggle_text_align=”left” toggle_font_size=”18px” body_font=”Roboto Mono||||||||” body_text_color=”#989db0″ body_font_size=”13px” custom_margin=”||100px|” custom_padding=”|||” border_radii=”on|4px|4px|4px|4px” border_width_all=”0px” border_color_all=”#d9d9d9″ border_style_all=”solid” box_shadow_style=”preset3″ box_shadow_color=”rgba(34,56,101,0.12)” use_border_color=”on” border_width=”0px” locked=”off” global_colors_info=”{}”][et_pb_accordion_item title=” Description” open=”on” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}”]<\/p>\n

This call is used to unlink a voucher type to a merchant account<\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” Resource URL” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

https:\/\/{BaseURL}\/unlinkMerchant?ns={{namespace}}<\/a><\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” UnlinkMerchant Request” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n\n\n
Name<\/span><\/td>\nType<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n<\/thead>\n
Merchant<\/span><\/td>\nstring<\/span><\/td>\nMerchant name<\/span><\/td>\n<\/tr>\n
VoucherType<\/span><\/td>\nstring<\/span><\/td>\n\n

Name of the voucher type<\/span><\/p>\n

Example: Book, Cash<\/span><\/p>\n<\/td>\n<\/tr>\n

Metadata<\/span><\/td>\nstring<\/span><\/td>\nAny other detail that the merchant wishes to store on this transaction Example: Teller name<\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” Request Header” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

Authorization: {{bearertoken}}<\/span><\/p>\n

Content-Type: application\/json<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” Request Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

{<\/span><\/p>\n

\u00a0\u00a0\u00a0 “Merchant”: “Merchant1”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “VoucherType”: “Flash”,<\/span><\/p>\n

“Metadata”: “{\\”ActionID\\”: \\”b37beb5b-e5d5-495c-8525-90b275ff4310\\”}”<\/p>\n

}<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” linkMerchant Response” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n\n\n\n
Name<\/span><\/td>\nType<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n<\/thead>\n
TID<\/span><\/td>\nstring<\/span><\/td>\n\n

TID (Transaction ID) of the executed API call<\/span><\/p>\n

Example: 1234-5678<\/span><\/p>\n<\/td>\n<\/tr>\n

State<\/span><\/td>\nstring<\/span><\/td>\n\n

Transaction state <\/span><\/p>\n

Example: Success, failed<\/span><\/p>\n<\/td>\n<\/tr>\n

Status<\/span><\/td>\nint<\/span><\/td>\n\n

Transaction status <\/span><\/p>\n

Example: 1 for success<\/span><\/p>\n<\/td>\n<\/tr>\n

Error<\/span><\/td>\nstring<\/span><\/td>\nFailure reason if applicable as notated Example: Insufficient funds<\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” Response Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

{<\/span><\/p>\n

\u00a0 “TID”: “9804699185”,<\/span><\/p>\n

\u00a0 “State”: “Success”,<\/span><\/p>\n

\u00a0 “Status”: “1”,<\/span><\/p>\n

\u00a0 “Error”: “”<\/span><\/p>\n

\u00a0}<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][\/et_pb_accordion][et_pb_text module_id=”UpdateActorAuth” _builder_version=”4.20.0″ text_font=”Nunito Sans||||||||” text_text_color=”#959baf” text_font_size=”18px” text_line_height=”1.8em” header_font=”||||||||” header_2_font=”Nunito Sans|700|||||||” header_2_text_color=”#535b7c” header_2_font_size=”35px” header_2_line_height=”1.3em” header_3_font=”Nunito Sans|700|||||||” header_3_text_color=”#535b7c” header_3_font_size=”25px” header_3_line_height=”1.3em” max_width=”700px” module_alignment=”center” global_colors_info=”{}”]<\/p>\n

16 – Update Actor Auth<\/h3>\n

[\/et_pb_text][et_pb_accordion open_toggle_background_color=”#ffffff” closed_toggle_background_color=”#ffffff” icon_color=”rgba(83,91,124,0.4)” _builder_version=”4.20.0″ toggle_text_color=”#535b7c” toggle_level=”h3″ toggle_font=”Roboto Mono|700|||||||” toggle_text_align=”left” toggle_font_size=”18px” body_font=”Roboto Mono||||||||” body_text_color=”#989db0″ body_font_size=”13px” custom_margin=”||100px|” custom_padding=”|||” border_radii=”on|4px|4px|4px|4px” border_width_all=”0px” border_color_all=”#d9d9d9″ border_style_all=”solid” box_shadow_style=”preset3″ box_shadow_color=”rgba(34,56,101,0.12)” use_border_color=”on” border_width=”0px” global_colors_info=”{}”][et_pb_accordion_item title=”Description” open=”on” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}”]<\/p>\n

This call is used to updates each TT property with the specified comma-delimited groups.<\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” Resource URL” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

https:\/\/{BaseURL}\/updateActorAuth?ns={{namespace}}<\/a><\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” updateActorAuth Request” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n\n\n
Name<\/span><\/td>\nType<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n<\/thead>\n
Actor<\/span><\/td>\nstring<\/span><\/td>\nEither user MSISDN; bearer Token; or oauth ClientID<\/span><\/td>\n<\/tr>\n
Metadata<\/span><\/td>\nstring<\/span><\/td>\nAny other detail that the merchant wishes to store on this transaction Example: Teller name<\/span><\/td>\n<\/tr>\n
\n

TT0,<\/span><\/p>\n

TT1,<\/span><\/p>\n

TT2,<\/span><\/p>\n

TT3,<\/span><\/p>\n

TT4,<\/span><\/p>\n

TT5,<\/span><\/p>\n

TT6,<\/span><\/p>\n

TT7,<\/span><\/p>\n

TT8,<\/span><\/p>\n

TT9,<\/span><\/p>\n

TT10,<\/span><\/p>\n

TT11,<\/span><\/p>\n

TT12,<\/span><\/p>\n

TT13,<\/span><\/p>\n

TT14,<\/span><\/p>\n

TT15,<\/span><\/p>\n

TT16,<\/span><\/p>\n

TT17,<\/span><\/p>\n

TT18,<\/span><\/p>\n

TT19,<\/span><\/p>\n

TT20,<\/span><\/p>\n

TT21,<\/span><\/p>\n

TT22,<\/span><\/p>\n

TT23,<\/span><\/p>\n

TT24,<\/span><\/p>\n

TT25,<\/span><\/p>\n

TT26,<\/span><\/p>\n

TT27,<\/span><\/p>\n

TT28,<\/span><\/p>\n

TT29,<\/span><\/p>\n

TT30,<\/span><\/p>\n

TT31,<\/span><\/p>\n

TT32,<\/span><\/p>\n

TT1000,<\/span><\/p>\n

TT1100,<\/span><\/p>\n

TT1200,<\/span><\/p>\n

TT1300,<\/span><\/p>\n

TT1400,<\/span><\/p>\n

TT1500,<\/span><\/p>\n

TT1600,<\/span><\/p>\n

TT1700,<\/span><\/p>\n

TT1800,<\/span><\/p>\n

TT1900,<\/span><\/p>\n

TT2000,<\/span><\/p>\n

TT2001,<\/span><\/p>\n

TT2002,<\/span><\/p>\n

TT2003,<\/span><\/p>\n

TT2004,<\/span><\/p>\n

TT2005,<\/span><\/p>\n

TT2006,<\/span><\/p>\n

TT2007,<\/span><\/p>\n

TT2008,<\/span><\/p>\n

TT2009,<\/span><\/p>\n

TT2010,<\/span><\/p>\n

TT2011,<\/span><\/p>\n

TT2012,<\/span><\/p>\n

TT2013,<\/span><\/p>\n

TT2014,<\/span><\/p>\n

TT2015,<\/span><\/p>\n

TT2016,<\/span><\/p>\n

TT2017,<\/span><\/p>\n

TT2018,<\/span><\/p>\n

TT2019,<\/span><\/p>\n

TT2020,<\/span><\/p>\n

TT2021,<\/span><\/p>\n

TT2022,<\/span><\/p>\n

TT2023,<\/span><\/p>\n

TT2024,<\/span><\/p>\n

TT2025,<\/span><\/p>\n

TT2026,<\/span><\/p>\n

TT2027,<\/span><\/p>\n

TT2028,<\/span><\/p>\n

TT2029,<\/span><\/p>\n

TT2030,<\/span><\/p>\n

TT2031,<\/span><\/p>\n

TT2032,<\/span><\/p>\n

TT2033,<\/span><\/p>\n

TT2034,<\/span><\/p>\n

TT2035,<\/span><\/p>\n

TT2036,<\/span><\/p>\n

TT2037,<\/span><\/p>\n

TT2038,<\/span><\/p>\n

TT2039,<\/span><\/p>\n

TT2040,<\/span><\/p>\n

TT2041,<\/span><\/p>\n

TT2042,<\/span><\/p>\n

TT2043,<\/span><\/p>\n

TT2044,<\/span><\/p>\n

TT2045,<\/span><\/p>\n

TT2046,<\/span><\/p>\n

TT2047,<\/span><\/p>\n

TT2048,<\/span><\/p>\n

TT3000,<\/span><\/p>\n

TT3001,<\/span><\/p>\n

TT3002,<\/span><\/p>\n

TT3003,<\/span><\/p>\n

TT3004,<\/span><\/p>\n

TT3005,<\/span><\/p>\n

TT3006,<\/span><\/p>\n

TT3007,<\/span><\/p>\n

TT3008,<\/span><\/p>\n

TT3009,<\/span><\/p>\n

TT3010,<\/span><\/p>\n

TT3011,<\/span><\/p>\n

TT3012,<\/span><\/p>\n

TT3013,<\/span><\/p>\n

TT3014,<\/span><\/p>\n

TT3015,<\/span><\/p>\n

TT3016,<\/span><\/p>\n

TT3017,<\/span><\/p>\n

TT3018,<\/span><\/p>\n

TT3019,<\/span><\/p>\n

TT2049,<\/span><\/p>\n<\/td>\n

String<\/span><\/td>\nAll Transaction Type (TT) fields are comma-delimited lists of communities<\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” Request Header” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

Authorization: {{bearertoken}}<\/span><\/p>\n

Content-Type: application\/json<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” Request Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

{<\/span><\/p>\n

\u00a0\u00a0\u00a0 “Actor”: “bearer~{{celbux-bearer-token}}”, <\/span><\/p>\n

“Metadata”: “{\\”ActionID\\”: \\”b37beb5b-e5d5-495c-8525-90b275ff4310\\”}”,<\/p>\n

“TT0”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT1”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT3”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT4”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT5”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT6”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT7”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT8”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT9”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT10”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT11”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT12”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT13”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT14”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT15”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT16”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT17”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT18”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT19”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT20”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT21”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT22”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT23”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT24”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT25”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT26”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT27”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT28”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT29”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT30”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT31”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT32”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT1000”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT1100”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT1200”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT1300”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT1400”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT1500”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT1600”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT1700”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT1800”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT1900”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2000”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2001”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2002”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2003”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2004”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2005”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2006”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2007”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2008”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2009”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2010”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2011”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2012”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2013”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2014”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2015”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2016”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2017”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2018”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2019”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2020”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2021”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2022”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2023”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2024”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2025”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2026”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2027”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2028”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2029”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2030”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2031”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2032”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2033”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2034”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2035”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2036”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2037”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2038”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2039”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2040”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2041”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2042”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2043”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2044”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2045”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2046”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2047”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2048”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT3000”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT3001”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT3002”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT3003”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT3004”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT3005”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT3006”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT3007”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT3008”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT3009”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT3010”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT3011”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT3012”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT3013”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT3014”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT3015”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT3016”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT3017”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT3018”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT3019”: “celbux101”<\/span><\/p>\n

}<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” updateActorAuth Response” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n\n\n\n
Name<\/span><\/td>\nType<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n<\/thead>\n
TID<\/span><\/td>\nstring<\/span><\/td>\n\n

TID (Transaction ID) of the executed API call<\/span><\/p>\n

Example: 1234-5678<\/span><\/p>\n<\/td>\n<\/tr>\n

State<\/span><\/td>\nstring<\/span><\/td>\n\n

Transaction state <\/span><\/p>\n

Example: Success, failed<\/span><\/p>\n<\/td>\n<\/tr>\n

Status<\/span><\/td>\nint<\/span><\/td>\n\n

Transaction status <\/span><\/p>\n

Example: 1 for success<\/span><\/p>\n<\/td>\n<\/tr>\n

Error<\/span><\/td>\nstring<\/span><\/td>\nFailure reason if applicable as notated Example: Insufficient funds<\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” Response Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

{<\/span><\/p>\n

\u00a0\u00a0 \u00a0“TID”: “9804699185”,<\/span><\/p>\n

\u00a0\u00a0 \u00a0“State”: “Success”,<\/span><\/p>\n

\u00a0\u00a0 \u00a0“Status”: “1”,<\/span><\/p>\n

\u00a0\u00a0 \u00a0“Error”: “”<\/span><\/p>\n

\u00a0}<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][\/et_pb_accordion][et_pb_text module_id=”UpdateUser” _builder_version=”4.20.0″ text_font=”Nunito Sans||||||||” text_text_color=”#959baf” text_font_size=”18px” text_line_height=”1.8em” header_font=”||||||||” header_2_font=”Nunito Sans|700|||||||” header_2_text_color=”#535b7c” header_2_font_size=”35px” header_2_line_height=”1.3em” header_3_font=”Nunito Sans|700|||||||” header_3_text_color=”#535b7c” header_3_font_size=”25px” header_3_line_height=”1.3em” max_width=”700px” module_alignment=”center” global_colors_info=”{}”]<\/p>\n

17 – Update User<\/h3>\n

[\/et_pb_text][et_pb_accordion open_toggle_background_color=”#ffffff” closed_toggle_background_color=”#ffffff” icon_color=”rgba(83,91,124,0.4)” _builder_version=”4.20.0″ toggle_text_color=”#535b7c” toggle_level=”h3″ toggle_font=”Roboto Mono|700|||||||” toggle_text_align=”left” toggle_font_size=”18px” body_font=”Roboto Mono||||||||” body_text_color=”#989db0″ body_font_size=”13px” custom_margin=”||100px|” custom_padding=”|||” border_radii=”on|4px|4px|4px|4px” border_width_all=”0px” border_color_all=”#d9d9d9″ border_style_all=”solid” box_shadow_style=”preset3″ box_shadow_color=”rgba(34,56,101,0.12)” use_border_color=”on” border_width=”0px” global_colors_info=”{}”][et_pb_accordion_item title=” Description” open=”on” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}”]<\/p>\n

This call is used to update the users’ details<\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” Resource URL” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

https:\/\/{BaseURL}\/updateUser?ns={{namespace}}<\/a><\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” updateUser Request” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”][\/et_pb_accordion_item][et_pb_accordion_item title=” updateUser Request” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Name<\/span><\/td>\nType<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n<\/thead>\n
Username<\/span><\/td>\nstring<\/span><\/td>\nName used for customer\u2019s identification<\/span><\/td>\n<\/tr>\n
IDNumber<\/span><\/td>\nstring<\/span><\/td>\nRSA ID number 13 digit<\/span><\/td>\n<\/tr>\n
Merchant<\/span><\/td>\nstring<\/span><\/td>\nMerchant name<\/span><\/td>\n<\/tr>\n
KYC<\/span><\/td>\nstring<\/span><\/td>\nKnow Your Customer (KYC) limit<\/span><\/td>\n<\/tr>\n
Status<\/span><\/td>\nstring<\/span><\/td>\n\n

KYC status<\/span><\/p>\n

Example: ‘Open’, ‘Blocked’ or ‘Closed’<\/span><\/p>\n<\/td>\n<\/tr>\n

DisplayName<\/span><\/td>\nstring<\/span><\/td>\nHow customer\u2019s name is known in the platform<\/span><\/td>\n<\/tr>\n
FirstName<\/span><\/td>\nstring<\/span><\/td>\nCustomer\u2019s first name<\/span><\/td>\n<\/tr>\n
LastName<\/span><\/td>\nString<\/span><\/td>\nCustomer\u2019s last name<\/span><\/td>\n<\/tr>\n
MSISDN<\/span><\/td>\nstring<\/span><\/td>\nCustomer\u2019s mobile number<\/span><\/td>\n<\/tr>\n
Email<\/span><\/td>\nstring<\/span><\/td>\nCustomer\u2019s account<\/span><\/td>\n<\/tr>\n
Currency<\/span><\/td>\nstring<\/span><\/td>\nDefault currency of merchant Example: ZAR (ISO 4217 Currency Codes)<\/span><\/td>\n<\/tr>\n
HouseNumber<\/span><\/td>\nstring<\/span><\/td>\nCustomer\u2019s home number<\/span><\/td>\n<\/tr>\n
StreetName<\/span><\/td>\nstring<\/span><\/td>\nCustomer\u2019s street number<\/span><\/td>\n<\/tr>\n
Suburb<\/span><\/td>\nstring<\/span><\/td>\nCustomer\u2019s Suburb name<\/span><\/td>\n<\/tr>\n
Town<\/span><\/td>\nstring<\/span><\/td>\nCustomer\u2019s city name<\/span><\/td>\n<\/tr>\n
Province<\/span><\/td>\nstring<\/span><\/td>\nCustomer\u2019s province name<\/span><\/td>\n<\/tr>\n
AccountName<\/span><\/td>\nstring<\/span><\/td>\nCustomer\u2019s bank account display name<\/span><\/td>\n<\/tr>\n
AccountNumber<\/span><\/td>\nstring<\/span><\/td>\nCustomer\u2019s bank account number<\/span><\/td>\n<\/tr>\n
AccountType<\/span><\/td>\nstring<\/span><\/td>\nCustomer\u2019s bank account type<\/span><\/td>\n<\/tr>\n
BankName<\/span><\/td>\nstring<\/span><\/td>\nBank name<\/span><\/td>\n<\/tr>\n
BranchCode<\/span><\/td>\nstring<\/span><\/td>\nBank branch code<\/span><\/td>\n<\/tr>\n
Commission<\/span><\/td>\nstring<\/span><\/td>\nCommission rate fee<\/span><\/td>\n<\/tr>\n
CommercialRegistrationNumber<\/span><\/td>\nstring<\/span><\/td>\nCommercial Registration number<\/span><\/td>\n<\/tr>\n
TaxNumber<\/span><\/td>\nstring<\/span><\/td>\nSARS tax number<\/span><\/td>\n<\/tr>\n
Metadata<\/span><\/td>\nstring<\/span><\/td>\n\n

Any other detail that the merchant wishes to store on this transaction<\/span><\/p>\n

Example: Teller name<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” Request Header” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

Authorization: {{bearertoken}}<\/span><\/p>\n

Content-Type: application\/json<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” Request Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

{<\/span><\/p>\n

\u00a0\u00a0\u00a0 \/\/ User<\/span><\/p>\n

\u00a0\u00a0\u00a0 “Username”: “Merchant1”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “IDNumber”: “”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “KYC”: “”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “Status”: “”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 \/\/ Personal<\/span><\/p>\n

\u00a0\u00a0\u00a0 “DisplayName”: “”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “FirstName”: “”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “LastName”: “”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “MSISDN”: “”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “Email”: “”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “Currency”: “”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 \/\/ Address<\/span><\/p>\n

\u00a0\u00a0\u00a0 “HouseNumber”: “”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “StreetName”: “”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “Suburb”: “”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “Town”: “”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “Province”: “”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 \/\/ Bank<\/span><\/p>\n

\u00a0\u00a0\u00a0 “AccountName”: “”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “AccountNumber”: “”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “AccountType”: “”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “BankName”: “”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “BranchCode”: “”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 \/\/ Commercial<\/span><\/p>\n

\u00a0\u00a0\u00a0 “Commission”: “”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “CommercialRegistrationNumber”: “”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TaxNumber”: “”,<\/span><\/p>\n

“Metadata”: “{\\”ActionID\\”: \\”b37beb5b-e5d5-495c-8525-90b275ff4310\\”}”<\/p>\n

}<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” updateUser Response” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n\n\n\n
Name<\/span><\/td>\nType<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n<\/thead>\n
TID<\/span><\/td>\nstring<\/span><\/td>\n\n

TID (Transaction ID) of the executed API call<\/span><\/p>\n

Example: 1234-5678<\/span><\/p>\n<\/td>\n<\/tr>\n

State<\/span><\/td>\nstring<\/span><\/td>\n\n

Transaction state <\/span><\/p>\n

Example: Success, failed<\/span><\/p>\n<\/td>\n<\/tr>\n

Status<\/span><\/td>\nint<\/span><\/td>\n\n

Transaction status <\/span><\/p>\n

Example: 1 for success<\/span><\/p>\n<\/td>\n<\/tr>\n

Error<\/span><\/td>\nstring<\/span><\/td>\nFailure reason if applicable as notated Example: Insufficient funds<\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” Response Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

{<\/span><\/p>\n

\u00a0 “TID”: “9804699185”,<\/span><\/p>\n

\u00a0 “State”: “Success”,<\/span><\/p>\n

\u00a0 “Status”: “1”,<\/span><\/p>\n

\u00a0 “Error”: “”<\/span><\/p>\n

\u00a0}<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][\/et_pb_accordion][et_pb_text module_id=”UpdateVoucherType” _builder_version=”4.20.0″ text_font=”Nunito Sans||||||||” text_text_color=”#959baf” text_font_size=”18px” text_line_height=”1.8em” header_font=”||||||||” header_2_font=”Nunito Sans|700|||||||” header_2_text_color=”#535b7c” header_2_font_size=”35px” header_2_line_height=”1.3em” header_3_font=”Nunito Sans|700|||||||” header_3_text_color=”#535b7c” header_3_font_size=”25px” header_3_line_height=”1.3em” max_width=”700px” module_alignment=”center” global_colors_info=”{}”]<\/p>\n

18 – Update Voucher Type<\/h3>\n

[\/et_pb_text][et_pb_accordion open_toggle_background_color=”#ffffff” closed_toggle_background_color=”#ffffff” icon_color=”rgba(83,91,124,0.4)” _builder_version=”4.20.0″ toggle_text_color=”#535b7c” toggle_level=”h3″ toggle_font=”Roboto Mono|700|||||||” toggle_text_align=”left” toggle_font_size=”18px” body_font=”Roboto Mono||||||||” body_text_color=”#989db0″ body_font_size=”13px” custom_margin=”||100px|” custom_padding=”|||” border_radii=”on|4px|4px|4px|4px” border_width_all=”0px” border_color_all=”#d9d9d9″ border_style_all=”solid” box_shadow_style=”preset3″ box_shadow_color=”rgba(34,56,101,0.12)” use_border_color=”on” border_width=”0px” global_colors_info=”{}”][et_pb_accordion_item title=” Description” open=”on” _builder_version=”4.20.0″ global_colors_info=”{}”]<\/p>\n

This call is used to update a voucher type.<\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” Resource URL” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

https:\/\/{BaseURL}\/updateVoucherType?ns={{namespace}}<\/a><\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” linkMerchant Request” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Name<\/span><\/td>\nType<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n<\/thead>\n
AutoLock<\/span><\/td>\nstring<\/span><\/td>\n\n

Controls whether the voucher is relocked automatically on-spend<\/span><\/p>\n

Example: 1 or empty field<\/span><\/p>\n<\/td>\n<\/tr>\n

Locked<\/span><\/td>\nstring<\/span><\/td>\n\n

Controls whether new vouchers are locked by default<\/span><\/p>\n

Example: 1 or empty field<\/span><\/p>\n<\/td>\n<\/tr>\n

PIN<\/span><\/td>\nstring<\/span><\/td>\nAny value; The PIN of the voucher must be empty to spend, via \/updateVoucher (meaning PIN validation must be done externally before clearing it via API)<\/span><\/td>\n<\/tr>\n
ThirdParty<\/span><\/td>\nint<\/span><\/td>\nAny value (usually MSISDN); The ThirdPartyClear field of the voucher must match the value placed here, via \/updateVoucher<\/span><\/td>\n<\/tr>\n
VAccumulate<\/span><\/td>\nstring<\/span><\/td>\n\n

Controls whether new vouchers of this type are accumulated, or created standalone alongside each other<\/span><\/p>\n

Example: 1 or empty field<\/span><\/p>\n<\/td>\n<\/tr>\n

VMetadata<\/span><\/td>\n\u00a0<\/span><\/td>\nThe transaction must NOT include alcohol anywhere, and must contain merchant_name somewhere<\/span><\/td>\n<\/tr>\n
VoucherType<\/span><\/td>\n\u00a0<\/span><\/td>\n\n

Name of the voucher type<\/span><\/p>\n

Example: Book, Cash<\/span><\/p>\n<\/td>\n<\/tr>\n

VSettle<\/span><\/td>\n\u00a0<\/span><\/td>\n\n

Controls whether the voucher can be settled into the user’s cash balance<\/span><\/p>\n

Example: 1 or empty field<\/span><\/p>\n<\/td>\n<\/tr>\n

WithdrawFee<\/span><\/td>\nstring<\/span><\/td>\n\n

Amount in cents that it costs to withdraw this voucher as cash<\/span><\/p>\n

Example: 900<\/span><\/p>\n<\/td>\n<\/tr>\n

Metadata<\/span><\/td>\nstring<\/span><\/td>\nAny other detail that the merchant wishes to store on this transaction Example: Teller name<\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” Request Header” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

Authorization: {{bearertoken}}<\/span><\/p>\n

Content-Type: application\/json<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Request Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

{<\/span><\/p>\n

\u00a0\u00a0\u00a0 “AutoLock”: “”, <\/span><\/p>\n

\u00a0\u00a0\u00a0 “Locked”: “”, <\/span><\/p>\n

\u00a0\u00a0\u00a0 “PIN”: “”, <\/span><\/p>\n

\u00a0\u00a0\u00a0 “ThirdParty”: <\/span><\/p>\n

\u00a0\u00a0\u00a0 “VAccumulate”: “1\u201d,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “VMetadata”: “Contains![alcohol] Contains[merchant_name]”, <\/span><\/p>\n

\u00a0\u00a0\u00a0 “VoucherType”: “Book”, <\/span><\/p>\n

\u00a0\u00a0\u00a0 “VSettle”: “”, <\/span><\/p>\n

\u00a0\u00a0\u00a0 “WithdrawFee”: “900”, <\/span><\/p>\n

“Metadata”: “{\\”ActionID\\”: \\”b37beb5b-e5d5-495c-8525-90b275ff4310\\”}”<\/p>\n

}<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” updateVoucherType Response” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n\n\n\n
Name<\/span><\/td>\nType<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n<\/thead>\n
TID<\/span><\/td>\nstring<\/span><\/td>\n\n

TID (Transaction ID) of the executed API call<\/span><\/p>\n

Example: 1234-5678<\/span><\/p>\n<\/td>\n<\/tr>\n

State<\/span><\/td>\nstring<\/span><\/td>\n\n

Transaction state <\/span><\/p>\n

Example: Success, failed<\/span><\/p>\n<\/td>\n<\/tr>\n

Status<\/span><\/td>\nint<\/span><\/td>\n\n

Transaction status <\/span><\/p>\n

Example: 1 for success<\/span><\/p>\n<\/td>\n<\/tr>\n

Error<\/span><\/td>\nstring<\/span><\/td>\nFailure reason if applicable as notated Example: Insufficient funds<\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” Response Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

{<\/span><\/p>\n

\u00a0 “TID”: “9804699185”,<\/span><\/p>\n

\u00a0 “State”: “Success”,<\/span><\/p>\n

\u00a0 “Status”: “1”,<\/span><\/p>\n

\u00a0 “Error”: “”<\/span><\/p>\n

\u00a0}<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][\/et_pb_accordion][et_pb_text module_id=”ViewActorAuth” _builder_version=”4.20.0″ text_font=”Nunito Sans||||||||” text_text_color=”#959baf” text_font_size=”18px” text_line_height=”1.8em” header_font=”||||||||” header_2_font=”Nunito Sans|700|||||||” header_2_text_color=”#535b7c” header_2_font_size=”35px” header_2_line_height=”1.3em” header_3_font=”Nunito Sans|700|||||||” header_3_text_color=”#535b7c” header_3_font_size=”25px” header_3_line_height=”1.3em” max_width=”700px” module_alignment=”center” global_colors_info=”{}”]<\/p>\n

19 – View Actor Auth<\/h3>\n

[\/et_pb_text][et_pb_accordion open_toggle_background_color=”#ffffff” closed_toggle_background_color=”#ffffff” icon_color=”rgba(83,91,124,0.4)” _builder_version=”4.20.0″ toggle_text_color=”#535b7c” toggle_level=”h3″ toggle_font=”Roboto Mono|700|||||||” toggle_text_align=”left” toggle_font_size=”18px” body_font=”Roboto Mono||||||||” body_text_color=”#989db0″ body_font_size=”13px” custom_margin=”||100px|” custom_padding=”|||” border_radii=”on|4px|4px|4px|4px” border_width_all=”0px” border_color_all=”#d9d9d9″ border_style_all=”solid” box_shadow_style=”preset3″ box_shadow_color=”rgba(34,56,101,0.12)” use_border_color=”on” border_width=”0px” global_colors_info=”{}”][et_pb_accordion_item title=” Description” open=”on” _builder_version=”4.20.0″ global_colors_info=”{}”]<\/p>\n

This call is used to view which groups an actor can perform each TT on<\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” Resource URL” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

https:\/\/{BaseURL}\/viewActorAuth?ns={{namespace}}<\/a><\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”viewActorAuth Request” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n\n
Name<\/span><\/td>\nType<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n<\/thead>\n
Actor<\/span><\/td>\nstring<\/span><\/td>\nEither user MSISDN; bearer Token; or oauth ClientID<\/span><\/td>\n<\/tr>\n
Metadata<\/span><\/td>\nstring<\/span><\/td>\nAny other detail that the merchant wishes to store on this transaction Example: Teller name<\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” Request Header” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

Authorization: {{bearertoken}}<\/span><\/p>\n

Content-Type: application\/json<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

 <\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” Request Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

{<\/span><\/p>\n

\u00a0\u00a0\u00a0 “Actor”: “bearer~{{celbux-bearer-token}}”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 <\/span>“Metadata”: “{\\”ActionID\\”: \\”b37beb5b-e5d5-495c-8525-90b275ff4310\\”}”<\/p>\n

}<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

 <\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” viewActorAuth Response” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n\n\n\n\n
Name<\/span><\/td>\nType<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n<\/thead>\n
TID<\/span><\/td>\nstring<\/span><\/td>\n\n

TID (Transaction ID) of the executed API call<\/span><\/p>\n

Example: 1234-5678<\/span><\/p>\n<\/td>\n<\/tr>\n

TTs<\/span><\/td>\nString<\/span><\/td>\nAll Transaction Type (TT) fields are comma-delimited lists of communities<\/span><\/td>\n<\/tr>\n
State<\/span><\/td>\nstring<\/span><\/td>\nTransaction state Example: Success, failed<\/span><\/td>\n<\/tr>\n
Status<\/span><\/td>\nint<\/span><\/td>\nTransaction status Example: 1 for success<\/span><\/td>\n<\/tr>\n
Error<\/span><\/td>\nstring<\/span><\/td>\nFailure reason if applicable as notated Example: Insufficient funds<\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” Response Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

{<\/span><\/p>\n

\u00a0\u00a0\u00a0 \u201cTID\u201d: \u201c38689646\u201d<\/span><\/p>\n

“TT0”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT1”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT3”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT4”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT5”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT6”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT7”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT8”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT9”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT10”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT11”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT12”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT13”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT14”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT15”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT16”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT17”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT18”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT19”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT20”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT21”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT22”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT23”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT24”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT25”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT26”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT27”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT28”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT29”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT30”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT31”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT32”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT1000”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT1100”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT1200”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT1300”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT1400”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT1500”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT1600”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT1700”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT1800”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT1900”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2000”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2001”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2002”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2003”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2004”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2005”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2006”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2007”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2008”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2009”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2010”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2011”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2012”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2013”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2014”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2015”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2016”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2017”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2018”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2019”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2020”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2021”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2022”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2023”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2024”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2025”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2026”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2027”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2028”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2029”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2030”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2031”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2032”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2033”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2034”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2035”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2036”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2037”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2038”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2039”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2040”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2041”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2042”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2043”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2044”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2045”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2046”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2047”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT2048”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT3000”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT3001”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT3002”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT3003”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT3004”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT3005”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT3006”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT3007”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT3008”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT3009”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT3010”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT3011”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT3012”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT3013”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT3014”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT3015”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT3016”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT3017”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT3018”: “celbux101”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TT3019”: “celbux101”<\/span><\/p>\n

\u00a0\u00a0\u00a0 “State”: “Success”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “Status”: “1”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “Error”: “”<\/span><\/p>\n

}<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

 <\/p>\n

[\/et_pb_accordion_item][\/et_pb_accordion][et_pb_text module_id=”ViewCustomerTransactions” _builder_version=”4.20.0″ text_font=”Nunito Sans||||||||” text_text_color=”#959baf” text_font_size=”18px” text_line_height=”1.8em” header_font=”||||||||” header_2_font=”Nunito Sans|700|||||||” header_2_text_color=”#535b7c” header_2_font_size=”35px” header_2_line_height=”1.3em” header_3_font=”Nunito Sans|700|||||||” header_3_text_color=”#535b7c” header_3_font_size=”25px” header_3_line_height=”1.3em” max_width=”700px” module_alignment=”center” global_colors_info=”{}”]<\/p>\n

20 – View Customer Transactions<\/h3>\n

[\/et_pb_text][et_pb_accordion open_toggle_background_color=”#ffffff” closed_toggle_background_color=”#ffffff” icon_color=”rgba(83,91,124,0.4)” _builder_version=”4.20.0″ toggle_text_color=”#535b7c” toggle_level=”h3″ toggle_font=”Roboto Mono|700|||||||” toggle_text_align=”left” toggle_font_size=”18px” body_font=”Roboto Mono||||||||” body_text_color=”#989db0″ body_font_size=”13px” custom_margin=”||100px|” custom_padding=”|||” border_radii=”on|4px|4px|4px|4px” border_width_all=”0px” border_color_all=”#d9d9d9″ border_style_all=”solid” box_shadow_style=”preset3″ box_shadow_color=”rgba(34,56,101,0.12)” use_border_color=”on” border_width=”0px” global_colors_info=”{}”][et_pb_accordion_item title=” Description” open=”on” _builder_version=”4.20.0″ global_colors_info=”{}”]<\/p>\n

Use this call to view all transactions for an individual customer.<\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” Resource URL” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

https:\/\/{BaseURL}\/viewCustomerTransactions1?ns={{namespace}}<\/a><\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” viewCustomerTransactions1 Request” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n\n\n\n\n\n
Name<\/span><\/td>\nType<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n<\/thead>\n
IDNumber<\/span><\/td>\nstring<\/span><\/td>\n13 digit RSA ID number<\/span><\/td>\n<\/tr>\n
CellPhoneNumber<\/span><\/td>\nstring<\/span><\/td>\n10 digit mobile number<\/span><\/td>\n<\/tr>\n
TransactionType<\/span><\/td>\nstring<\/span><\/td>\nAll, Buy, Cash Out, Change, Commission, Deposit, EFT, EFT Reverse, Pay, Purchase, Receive, Reset, Reverse, Transfer, Voucher, Voucher Merchant or Withdraw<\/span><\/td>\n<\/tr>\n
DateFrom<\/span><\/td>\nstring<\/span><\/td>\n\n

Format used is yyyy\/MM\/dd HH.mm<\/span><\/p>\n

Example: 2013\/01\/01 12:00<\/span><\/p>\n<\/td>\n<\/tr>\n

DateTo<\/span><\/td>\nstring<\/span><\/td>\n\n

Format used is yyyy\/MM\/dd HH.mm<\/span><\/p>\n

Example: 2013\/01\/01 12:00<\/span><\/p>\n<\/td>\n<\/tr>\n

Metadata<\/span><\/td>\nstring<\/span><\/td>\n\n

Any other detail that this transaction needs<\/span><\/p>\n

Example: Teller name<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” Request Header” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

Authorization: {{bearertoken}}<\/span><\/p>\n

Content-Type: application\/json<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

 <\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” Request Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

{<\/span><\/p>\n

\u00a0 “CellPhoneNumber”: “Merchant1”,<\/span><\/p>\n

\u00a0 “DateFrom”: “2010\/01\/01 00:00”,<\/span><\/p>\n

\u00a0 “DateTo”: “2039\/12\/31 00:00”,<\/span><\/p>\n

\u00a0 “IDNumber”: “”,<\/span><\/p>\n

“Metadata”: “{\\”ActionID\\”: \\”b37beb5b-e5d5-495c-8525-90b275ff4310\\”}”,<\/p>\n

“TransactionType”: “All” <\/span><\/p>\n

}<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” viewCustomerTransactions1 Response” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n\n\n\n
Name<\/span><\/td>\nType<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n<\/thead>\n
TransactionList<\/span><\/td>\nInteger<\/span><\/td>\n\n

List of Transactions <\/span><\/p>\n

(JSON object per transaction type)<\/p>\n

Example: TID, Date, Time, Type, Amount, Fee, Recipient, ReverseID, ConfirmID, State, Reference and Metadata<\/p>\n<\/td>\n<\/tr>\n

State<\/span><\/td>\nstring<\/span><\/td>\n\n

Transaction state<\/span><\/p>\n

Example: Success, failed<\/span><\/p>\n<\/td>\n<\/tr>\n

Status<\/span><\/td>\nstring<\/span><\/td>\n\n

Transaction status<\/span><\/p>\n

Example: 1 for success<\/span><\/p>\n<\/td>\n<\/tr>\n

Error<\/span><\/td>\nstring<\/span><\/td>\n\n

Failure reason if applicable as notated<\/span><\/p>\n

Example: Not a valid customer<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

 <\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” Response Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

{<\/span><\/p>\n

\u00a0 “TransactionList”: [<\/span><\/p>\n

\u00a0\u00a0\u00a0 {<\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0\u00a0 “TID”: “9372539184”,<\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0\u00a0 “Date”: “2020\/05\/07”,<\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0\u00a0 “Time”: “12:52”,<\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0\u00a0 “Type”: “Voucher”,<\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0\u00a0 “Amount”: “300”,<\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0\u00a0 “Fee”: “0”,<\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0\u00a0 “Recipient”: “27671490778”,<\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0\u00a0 “ReverseID”: “0”,<\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0\u00a0 “ConfirmID”: “0”,<\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0\u00a0 “State”: “Success”,<\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0\u00a0 “Reference”: “149044227908”,<\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0\u00a0 “Metadata”: “”<\/span><\/p>\n

\u00a0\u00a0\u00a0 }<\/span><\/p>\n

\u00a0 ],<\/span><\/p>\n

\u00a0 “State”: “Success”,<\/span><\/p>\n

\u00a0 “Status”: “1”,<\/span><\/p>\n

\u00a0 “Error”: “”<\/span><\/p>\n

}<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][\/et_pb_accordion][et_pb_text module_id=”ViewMerchantStores” _builder_version=”4.20.0″ text_font=”Nunito Sans||||||||” text_text_color=”#959baf” text_font_size=”18px” text_line_height=”1.8em” header_font=”||||||||” header_2_font=”Nunito Sans|700|||||||” header_2_text_color=”#535b7c” header_2_font_size=”35px” header_2_line_height=”1.3em” header_3_font=”Nunito Sans|700|||||||” header_3_text_color=”#535b7c” header_3_font_size=”25px” header_3_line_height=”1.3em” max_width=”700px” module_alignment=”center” global_colors_info=”{}”]<\/p>\n

21 – View Merchant Stores<\/h3>\n

[\/et_pb_text][et_pb_accordion open_toggle_background_color=”#ffffff” closed_toggle_background_color=”#ffffff” icon_color=”rgba(83,91,124,0.4)” _builder_version=”4.20.0″ toggle_text_color=”#535b7c” toggle_level=”h3″ toggle_font=”Roboto Mono|700|||||||” toggle_text_align=”left” toggle_font_size=”18px” body_font=”Roboto Mono||||||||” body_text_color=”#989db0″ body_font_size=”13px” custom_margin=”||100px|” custom_padding=”|||” border_radii=”on|4px|4px|4px|4px” border_width_all=”0px” border_color_all=”#d9d9d9″ border_style_all=”solid” box_shadow_style=”preset3″ box_shadow_color=”rgba(34,56,101,0.12)” use_border_color=”on” border_width=”0px” global_colors_info=”{}”][et_pb_accordion_item title=” Description” open=”on” _builder_version=”4.20.0″ global_colors_info=”{}”]<\/p>\n

Use this call to pull the list of stores.<\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” Resource URL” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

https:\/\/{BaseURL}\/viewMerchantStores?ns={{namespace}}<\/a><\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” viewMerchantStores Request” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n\n
Name<\/span><\/td>\nType<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n<\/thead>\n
BearerToken<\/span><\/td>\nstring<\/span><\/td>\n\n

Security token used for API authentication<\/span><\/p>\n

Example: Ty574u9vfBnYY54592jfl5474<\/span><\/p>\n<\/td>\n<\/tr>\n

Metadata<\/span><\/td>\nstring<\/span><\/td>\n\n

Any other detail that this transaction needs<\/span><\/p>\n

Example: Teller name<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” Request Header” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

Authorization: {{bearertoken}} <\/span><\/p>\n

Content-Type: application\/json<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” Request Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

{<\/span><\/p>\n

\u00a0\u00a0\u00a0 “BearerToken”: “jM3hxb7BVaDsl5RqRf8qsSdOPJWKh1PEIcgmAHAbyXg=”,<\/span><\/p>\n

“Metadata”: “{\\”ActionID\\”: \\”b37beb5b-e5d5-495c-8525-90b275ff4310\\”}”<\/p>\n

}<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” viewMerchantStores Response” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n\n\n\n\n
Name<\/span><\/td>\nType<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n<\/thead>\n
StoreList<\/span><\/td>\nInteger<\/span><\/td>\n\n

List of Stores <\/span><\/p>\n

Example: StoreID,MEID,Username<\/p>\n<\/td>\n<\/tr>\n

TID<\/span><\/td>\nstring<\/span><\/td>\n\n

TID (Transaction ID) of the executed API call<\/span><\/p>\n

Example: 1234-5678<\/span><\/p>\n<\/td>\n<\/tr>\n

State<\/span><\/td>\nstring<\/span><\/td>\n\n

Transaction state<\/span><\/p>\n

Example: Success, failed<\/span><\/p>\n<\/td>\n<\/tr>\n

Status<\/span><\/td>\nstring<\/span><\/td>\n\n

Transaction status<\/span><\/p>\n

Example: 1 for success<\/span><\/p>\n<\/td>\n<\/tr>\n

Error<\/span><\/td>\nstring<\/span><\/td>\n\n

Failure reason if applicable as notated<\/span><\/p>\n

Example: Not a valid customer<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” Response Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

{<\/span><\/p>\n

\u00a0 “StoreList”: [<\/span><\/p>\n

\u00a0\u00a0\u00a0 {<\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0\u00a0 “StoreID”: “9372539184”,<\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0\u00a0 “MEID”: “27671490778”,<\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0\u00a0 “Username”: “JP Mark”<\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0\u00a0 }<\/span><\/p>\n

\u00a0 ],<\/span><\/p>\n

\u00a0 “TID”: “3456465462”,<\/span><\/p>\n

\u00a0 “State”: “Success”,<\/span><\/p>\n

\u00a0 “Status”: “1”,<\/span><\/p>\n

\u00a0 “Error”: “”<\/span><\/p>\n

}<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][\/et_pb_accordion][et_pb_text module_id=”ViewMerchantVoucherTypes” _builder_version=”4.20.0″ text_font=”Nunito Sans||||||||” text_text_color=”#959baf” text_font_size=”18px” text_line_height=”1.8em” header_font=”||||||||” header_2_font=”Nunito Sans|700|||||||” header_2_text_color=”#535b7c” header_2_font_size=”35px” header_2_line_height=”1.3em” header_3_font=”Nunito Sans|700|||||||” header_3_text_color=”#535b7c” header_3_font_size=”25px” header_3_line_height=”1.3em” max_width=”700px” module_alignment=”center” global_colors_info=”{}”]<\/p>\n

22 – View Merchant Voucher Types<\/h3>\n

[\/et_pb_text][et_pb_accordion open_toggle_background_color=”#ffffff” closed_toggle_background_color=”#ffffff” icon_color=”rgba(83,91,124,0.4)” _builder_version=”4.20.0″ toggle_text_color=”#535b7c” toggle_level=”h3″ toggle_font=”Roboto Mono|700|||||||” toggle_text_align=”left” toggle_font_size=”18px” body_font=”Roboto Mono||||||||” body_text_color=”#989db0″ body_font_size=”13px” custom_margin=”||100px|” custom_padding=”|||” border_radii=”on|4px|4px|4px|4px” border_width_all=”0px” border_color_all=”#d9d9d9″ border_style_all=”solid” box_shadow_style=”preset3″ box_shadow_color=”rgba(34,56,101,0.12)” use_border_color=”on” border_width=”0px” global_colors_info=”{}”][et_pb_accordion_item title=” Description” open=”on” _builder_version=”4.20.0″ global_colors_info=”{}”]<\/p>\n

Use this call to pull the list of merchant voucher types.<\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” Resource URL” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

https:\/\/{BaseURL}\/viewMerchantVoucherTypes?ns={{namespace}}<\/a><\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” viewMerchantVoucherTypes Request” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n\n
Name<\/span><\/td>\nType<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n<\/thead>\n
Merchant<\/span><\/td>\nstring<\/span><\/td>\nMerchant name<\/span><\/td>\n<\/tr>\n
Metadata<\/span><\/td>\nstring<\/span><\/td>\n\n

Any other detail that this transaction needs<\/span><\/p>\n

Example: Teller name<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Request Header” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

Authorization: {{bearertoken}} <\/span><\/p>\n

Content-Type: application\/json<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”11.3.2 Request Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

{<\/span><\/p>\n

\u00a0\u00a0\u00a0 “Merchant”: “Merchant1”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “Metadata”: “{\\”ActionID\\”: \\”b37beb5b-e5d5-495c-8525-90b275ff4310\\”}”<\/p>\n

}<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

 <\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” viewMerchantVoucherTypes Response” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n\n\n\n\n
Name<\/span><\/td>\nType<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n<\/thead>\n
TID<\/span><\/td>\nInteger<\/span><\/td>\n\n

TID (Transaction ID) of the executed API call<\/span><\/p>\n

Example: 1234-5678<\/span><\/p>\n<\/td>\n<\/tr>\n

VoucherTypes<\/span><\/td>\nstring<\/span><\/td>\n\n

Name of the voucher type<\/span><\/p>\n

Example: Book, Cash<\/span><\/p>\n<\/td>\n<\/tr>\n

State<\/span><\/td>\nstring<\/span><\/td>\n\n

Transaction state<\/span><\/p>\n

Example: Success, failed<\/span><\/p>\n<\/td>\n<\/tr>\n

Status<\/span><\/td>\nstring<\/span><\/td>\n\n

Transaction status<\/span><\/p>\n

Example: 1 for success<\/span><\/p>\n<\/td>\n<\/tr>\n

Error<\/span><\/td>\nstring<\/span><\/td>\n\n

Failure reason if applicable as notated<\/span><\/p>\n

Example: Not a valid customer<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Response Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

{<\/span><\/p>\n

\u00a0 “TID”: “9372539184”,<\/span><\/p>\n

\u00a0 “VoucherTypes”: “Book, Cash”,<\/span><\/p>\n

\u00a0 “State”: “Success”,<\/span><\/p>\n

\u00a0 “Status”: “1”,<\/span><\/p>\n

\u00a0 “Error”: “”<\/span><\/p>\n

}<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][\/et_pb_accordion][et_pb_text module_id=”ViewUsers” _builder_version=”4.20.0″ text_font=”Nunito Sans||||||||” text_text_color=”#959baf” text_font_size=”18px” text_line_height=”1.8em” header_font=”||||||||” header_2_font=”Nunito Sans|700|||||||” header_2_text_color=”#535b7c” header_2_font_size=”35px” header_2_line_height=”1.3em” header_3_font=”Nunito Sans|700|||||||” header_3_text_color=”#535b7c” header_3_font_size=”25px” header_3_line_height=”1.3em” max_width=”700px” module_alignment=”center” global_colors_info=”{}”]<\/p>\n

23 – View Users<\/h3>\n

[\/et_pb_text][et_pb_accordion open_toggle_background_color=”#ffffff” closed_toggle_background_color=”#ffffff” icon_color=”rgba(83,91,124,0.4)” _builder_version=”4.20.0″ toggle_text_color=”#535b7c” toggle_level=”h3″ toggle_font=”Roboto Mono|700|||||||” toggle_text_align=”left” toggle_font_size=”18px” body_font=”Roboto Mono||||||||” body_text_color=”#989db0″ body_font_size=”13px” custom_margin=”||100px|” custom_padding=”|||” border_radii=”on|4px|4px|4px|4px” border_width_all=”0px” border_color_all=”#d9d9d9″ border_style_all=”solid” box_shadow_style=”preset3″ box_shadow_color=”rgba(34,56,101,0.12)” use_border_color=”on” border_width=”0px” global_colors_info=”{}”][et_pb_accordion_item title=” Description” open=”on” _builder_version=”4.20.0″ global_colors_info=”{}”]<\/p>\n

Use this call to pull the list of stores.<\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” Resource URL” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

https:\/\/{BaseURL}\/viewUser?ns={{namespace}}<\/a><\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” viewUser Request” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n\n\n
Name<\/span><\/td>\nType<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n<\/thead>\n
Username<\/span><\/td>\nstring<\/span><\/td>\nName used for customer\u2019s identification<\/span><\/td>\n<\/tr>\n
IDNumber<\/span><\/td>\nString<\/span><\/td>\nRSA ID number 13 digit<\/span><\/td>\n<\/tr>\n
Metadata<\/span><\/td>\nstring<\/span><\/td>\n\n

Any other detail that this transaction needs<\/span><\/p>\n

Example: Teller name<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” Request Header” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

Authorization: {{bearertoken}} <\/span><\/p>\n

Content-Type: application\/json<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” Request Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

{<\/span><\/p>\n

\u00a0\u00a0\u00a0 “Username”: “Merchant1”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “IDNumber”: “”,<\/span><\/p>\n

“Metadata”: “{\\”ActionID\\”: \\”b37beb5b-e5d5-495c-8525-90b275ff4310\\”}”<\/p>\n

}<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” viewUser Response” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Name<\/span><\/td>\nType<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n<\/thead>\n
Username<\/span><\/td>\nstring<\/span><\/td>\nName used for customer\u2019s identification<\/span><\/td>\n<\/tr>\n
IDNumber<\/span><\/td>\nstring<\/span><\/td>\nRSA ID number 13 digit<\/span><\/td>\n<\/tr>\n
Merchant<\/span><\/td>\nstring<\/span><\/td>\nMerchant name<\/span><\/td>\n<\/tr>\n
KYC<\/span><\/td>\nstring<\/span><\/td>\nKnow Your Customer (KYC) limit<\/span><\/td>\n<\/tr>\n
Status<\/span><\/td>\nstring<\/span><\/td>\n\n

KYC status<\/span><\/p>\n

Example: ‘Open’, ‘Blocked’ or ‘Closed’<\/span><\/p>\n<\/td>\n<\/tr>\n

DisplayName<\/span><\/td>\nstring<\/span><\/td>\nHow customer\u2019s name is known in the platform<\/span><\/td>\n<\/tr>\n
FirstName<\/span><\/td>\nstring<\/span><\/td>\nCustomer\u2019s first name<\/span><\/td>\n<\/tr>\n
LastName<\/span><\/td>\nString<\/span><\/td>\nCustomer\u2019s last name<\/span><\/td>\n<\/tr>\n
MSISDN<\/span><\/td>\nstring<\/span><\/td>\nCustomer\u2019s mobile number<\/span><\/td>\n<\/tr>\n
Email<\/span><\/td>\nstring<\/span><\/td>\nCustomer\u2019s account<\/span><\/td>\n<\/tr>\n
Currency<\/span><\/td>\nstring<\/span><\/td>\nDefault currency of merchant Example: ZAR (ISO 4217 Currency Codes)<\/span><\/td>\n<\/tr>\n
HouseNumber<\/span><\/td>\nstring<\/span><\/td>\nCustomer\u2019s home number<\/span><\/td>\n<\/tr>\n
StreetName<\/span><\/td>\nstring<\/span><\/td>\nCustomer\u2019s street number<\/span><\/td>\n<\/tr>\n
Suburb<\/span><\/td>\nstring<\/span><\/td>\nCustomer\u2019s Suburb name<\/span><\/td>\n<\/tr>\n
Town<\/span><\/td>\nstring<\/span><\/td>\nCustomer\u2019s city name<\/span><\/td>\n<\/tr>\n
Province<\/span><\/td>\nstring<\/span><\/td>\nCustomer\u2019s province name<\/span><\/td>\n<\/tr>\n
AccountName<\/span><\/td>\nstring<\/span><\/td>\nCustomer\u2019s bank account display name<\/span><\/td>\n<\/tr>\n
AccountNumber<\/span><\/td>\nstring<\/span><\/td>\nCustomer\u2019s bank account number<\/span><\/td>\n<\/tr>\n
AccountType<\/span><\/td>\nstring<\/span><\/td>\nCustomer\u2019s bank account type<\/span><\/td>\n<\/tr>\n
BankName<\/span><\/td>\nstring<\/span><\/td>\nBank name<\/span><\/td>\n<\/tr>\n
BranchCode<\/span><\/td>\nstring<\/span><\/td>\nBank branch code<\/span><\/td>\n<\/tr>\n
Commission<\/span><\/td>\nstring<\/span><\/td>\nCommission rate fee<\/span><\/td>\n<\/tr>\n
CommercialRegistrationNumber<\/span><\/td>\nstring<\/span><\/td>\nCommercial Registration number<\/span><\/td>\n<\/tr>\n
TaxNumber<\/span><\/td>\nstring<\/span><\/td>\nSARS tax number<\/span><\/td>\n<\/tr>\n
State<\/span><\/td>\nstring<\/span><\/td>\n\n

Transaction state<\/span><\/p>\n

Example: Success, failed<\/span><\/p>\n<\/td>\n<\/tr>\n

Status<\/span><\/td>\nstring<\/span><\/td>\n\n

Transaction status<\/span><\/p>\n

Example: 1 for success<\/span><\/p>\n<\/td>\n<\/tr>\n

Error<\/span><\/td>\nstring<\/span><\/td>\n\n

Failure reason if applicable as notated<\/span><\/p>\n

Example: Not a valid customer<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” Response Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

{<\/span><\/p>\n

\u00a0\u00a0\u00a0 \u201cTID\u201d: \u201c\u201d, <\/span><\/p>\n

\u00a0\u00a0\u00a0 \u201cUsername\u201d: \u201c\u201d, <\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0 \u201cIDNumber, <\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0 \u201cKYC, <\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0 \u201cUserStatus, <\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0 \u201cDisplayName, <\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0 \u201cFirstName, <\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0 \u201cLastName, <\/span><\/p>\n

\u00a0\u00a0\u00a0 \u201cMSISDN, <\/span><\/p>\n

\u00a0\u00a0\u00a0 \u201cEmail, <\/span><\/p>\n

\u00a0\u00a0\u00a0 \u201cCurrency, <\/span><\/p>\n

\u00a0\u00a0\u00a0 \u201cBankName,<\/span><\/p>\n

\u00a0\u00a0\u00a0 \u201cBranchCode ,<\/span><\/p>\n

\u00a0\u00a0\u00a0 \u201cAccountName, <\/span><\/p>\n

\u00a0\u00a0\u00a0 \u201cAccountNumber, <\/span><\/p>\n

\u00a0\u00a0\u00a0 \u201cAccountType, <\/span><\/p>\n

\u00a0\u00a0\u00a0 \u201cHouseNumber, <\/span><\/p>\n

\u00a0\u00a0\u00a0 \u201cStreetName, <\/span><\/p>\n

\u00a0\u00a0 \u201cSuburb, <\/span><\/p>\n

\u00a0\u00a0 \u201cTown, <\/span><\/p>\n

\u00a0\u00a0 \u201cProvince, <\/span><\/p>\n

\u00a0\u00a0 \u201cCommission, <\/span><\/p>\n

\u00a0\u00a0 \u201cCommercialRegistrationNumber, <\/span><\/p>\n

\u00a0\u00a0 \u201cTaxNumber, <\/span><\/p>\n

\u00a0 \u00a0“State”: “Success”,<\/span><\/p>\n

\u00a0 \u00a0“Status”: “1”,<\/span><\/p>\n

\u00a0 \u00a0“Error”: “”<\/span><\/p>\n

}<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][\/et_pb_accordion][et_pb_text module_id=”ViewUserCommunities” _builder_version=”4.20.0″ text_font=”Nunito Sans||||||||” text_text_color=”#959baf” text_font_size=”18px” text_line_height=”1.8em” header_font=”||||||||” header_2_font=”Nunito Sans|700|||||||” header_2_text_color=”#535b7c” header_2_font_size=”35px” header_2_line_height=”1.3em” header_3_font=”Nunito Sans|700|||||||” header_3_text_color=”#535b7c” header_3_font_size=”25px” header_3_line_height=”1.3em” max_width=”700px” module_alignment=”center” global_colors_info=”{}”]<\/p>\n

24 – View User Communities<\/h3>\n

[\/et_pb_text][et_pb_accordion open_toggle_background_color=”#ffffff” closed_toggle_background_color=”#ffffff” icon_color=”rgba(83,91,124,0.4)” _builder_version=”4.20.0″ toggle_text_color=”#535b7c” toggle_level=”h3″ toggle_font=”Roboto Mono|700|||||||” toggle_text_align=”left” toggle_font_size=”18px” body_font=”Roboto Mono||||||||” body_text_color=”#989db0″ body_font_size=”13px” custom_margin=”||100px|” custom_padding=”|||” border_radii=”on|4px|4px|4px|4px” border_width_all=”0px” border_color_all=”#d9d9d9″ border_style_all=”solid” box_shadow_style=”preset3″ box_shadow_color=”rgba(34,56,101,0.12)” use_border_color=”on” border_width=”0px” global_colors_info=”{}”][et_pb_accordion_item title=” Description” open=”on” _builder_version=”4.20.0″ global_colors_info=”{}”]<\/p>\n

Use this call to pull the list of communities the user is member of.<\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” Resource URL” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

https:\/\/{BaseURL}\/viewUserCommunities?ns={{namespace}}<\/a><\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” viewUserCommunities Request” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n\n\n
Name<\/span><\/td>\nType<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n<\/thead>\n
Username<\/span><\/td>\nstring<\/span><\/td>\nName used for customer\u2019s identification<\/span><\/td>\n<\/tr>\n
IDNumber<\/span><\/td>\nString<\/span><\/td>\nRSA ID number 13 digit<\/span><\/td>\n<\/tr>\n
Metadata<\/span><\/td>\nstring<\/span><\/td>\n\n

Any other detail that this transaction needs<\/span><\/p>\n

Example: Teller name<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” Request Header” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

Authorization: {{bearertoken}} <\/span><\/p>\n

Content-Type: application\/json<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Request Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

{<\/span><\/p>\n

\u00a0\u00a0\u00a0 “Username”: “Merchant1”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “IDNumber”: “”,<\/span><\/p>\n

“Metadata”: “{\\”ActionID\\”: \\”b37beb5b-e5d5-495c-8525-90b275ff4310\\”}”<\/p>\n

}<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” viewUserCommunities Response” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n\n\n\n\n
Name<\/span><\/td>\nType<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n<\/thead>\n
TID<\/span><\/td>\nInteger<\/span><\/td>\n\n

TID (Transaction ID) of the executed API call<\/span><\/p>\n

Example: 1234-5678<\/span><\/p>\n<\/td>\n<\/tr>\n

Communities<\/span><\/td>\nstring<\/span><\/td>\nlist of communities<\/span><\/td>\n<\/tr>\n
State<\/span><\/td>\nstring<\/span><\/td>\n\n

Transaction state<\/span><\/p>\n

Example: Success, failed<\/span><\/p>\n<\/td>\n<\/tr>\n

Status<\/span><\/td>\nstring<\/span><\/td>\n\n

Transaction status<\/span><\/p>\n

Example: 1 for success<\/span><\/p>\n<\/td>\n<\/tr>\n

Error<\/span><\/td>\nstring<\/span><\/td>\n\n

Failure reason if applicable as notated<\/span><\/p>\n

Example: Not a valid customer<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” Response Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

{<\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0 “TID”: “9372539184”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “Communities”: “Celbux101”,<\/span><\/p>\n

\u00a0 \u00a0\u00a0“State”: “Success”,<\/span><\/p>\n

\u00a0 \u00a0\u00a0“Status”: “1”,<\/span><\/p>\n

\u00a0 \u00a0\u00a0“Error”: “”<\/span><\/p>\n

}<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][\/et_pb_accordion][et_pb_text module_id=”ViewVoucher” _builder_version=”4.20.0″ text_font=”Nunito Sans||||||||” text_text_color=”#959baf” text_font_size=”18px” text_line_height=”1.8em” header_font=”||||||||” header_2_font=”Nunito Sans|700|||||||” header_2_text_color=”#535b7c” header_2_font_size=”35px” header_2_line_height=”1.3em” header_3_font=”Nunito Sans|700|||||||” header_3_text_color=”#535b7c” header_3_font_size=”25px” header_3_line_height=”1.3em” max_width=”700px” module_alignment=”center” global_colors_info=”{}”]<\/p>\n

25 – View Voucher<\/h3>\n

[\/et_pb_text][et_pb_accordion open_toggle_background_color=”#ffffff” closed_toggle_background_color=”#ffffff” icon_color=”rgba(83,91,124,0.4)” _builder_version=”4.20.0″ toggle_text_color=”#535b7c” toggle_level=”h3″ toggle_font=”Roboto Mono|700|||||||” toggle_text_align=”left” toggle_font_size=”18px” body_font=”Roboto Mono||||||||” body_text_color=”#989db0″ body_font_size=”13px” custom_margin=”||100px|” custom_padding=”|||” border_radii=”on|4px|4px|4px|4px” border_width_all=”0px” border_color_all=”#d9d9d9″ border_style_all=”solid” box_shadow_style=”preset3″ box_shadow_color=”rgba(34,56,101,0.12)” use_border_color=”on” border_width=”0px” global_colors_info=”{}”][et_pb_accordion_item title=” Description” open=”on” _builder_version=”4.20.0″ global_colors_info=”{}”]<\/p>\n

Use this call to pull the voucher’s details.<\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” Resource URL” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

https:\/\/{BaseURL}\/viewVoucher?ns={{namespace}}<\/a><\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” viewVoucher Request” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n\n
Name<\/span><\/td>\nType<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n<\/thead>\n
VoucherNo<\/span><\/td>\nstring<\/span><\/td>\n\n

A valid voucher number <\/span><\/p>\n

Example: 335-29543-25430<\/span><\/p>\n<\/td>\n<\/tr>\n

Metadata<\/span><\/td>\nstring<\/span><\/td>\n\n

Any other detail that this transaction needs<\/span><\/p>\n

Example: Teller name<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” Request Header” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

Authorization: {{bearertoken}} <\/span><\/p>\n

Content-Type: application\/json<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” Request Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

{<\/span><\/p>\n

\u00a0\u00a0\u00a0 “VoucherNo”: “335-29543-25430”,<\/span><\/p>\n

“Metadata”: “{\\”ActionID\\”: \\”b37beb5b-e5d5-495c-8525-90b275ff4310\\”}”<\/p>\n

}<\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” viewVoucher Response” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Name<\/td>\nType<\/td>\nDescription<\/td>\n<\/tr>\n
VoucherNO<\/span><\/td>\n\u00a0<\/span><\/td>\n\n

A valid voucher number <\/span><\/p>\n

Example: 335-29543-25430<\/span><\/p>\n<\/td>\n<\/tr>\n

AutoLock<\/span><\/td>\nstring<\/span><\/td>\n\n

Controls whether the voucher is relocked automatically on-spend<\/span><\/p>\n

Example: 1 or empty field<\/span><\/p>\n<\/td>\n<\/tr>\n

Locked<\/span><\/td>\nstring<\/span><\/td>\n\n

Controls whether new vouchers are locked by default<\/span><\/p>\n

Example: 1 or empty field<\/span><\/p>\n<\/td>\n<\/tr>\n

Title<\/span><\/td>\n\u00a0<\/span><\/td>\nTitle name<\/span><\/td>\n<\/tr>\n
Amount<\/span><\/td>\n\u00a0<\/span><\/td>\nTransaction amount in cents Example: 2000 (R 20.00)<\/span><\/td>\n<\/tr>\n
PIN<\/span><\/td>\nstring<\/span><\/td>\nAny value; The PIN of the voucher must be empty to spend, via \/updateVoucher (meaning PIN validation must be done externally before clearing it via API)<\/span><\/td>\n<\/tr>\n
ThirdParty<\/span><\/td>\nint<\/span><\/td>\nAny value (usually MSISDN); The ThirdPartyClear field of the voucher must match the value placed here, via \/updateVoucher<\/span><\/td>\n<\/tr>\n
ThirdPartyClear<\/span><\/td>\n\u00a0<\/span><\/td>\n\u00a0<\/span><\/td>\n<\/tr>\n
TransactionOverrides<\/span><\/td>\n\u00a0<\/span><\/td>\n\u00a0<\/span><\/td>\n<\/tr>\n
VAccumulate<\/span><\/td>\nstring<\/span><\/td>\n\n

Controls whether new vouchers of this type are accumulated, or created standalone alongside each other<\/span><\/p>\n

Example: 1 or empty field<\/span><\/p>\n<\/td>\n<\/tr>\n

VMetadata<\/span><\/td>\n\u00a0<\/span><\/td>\nThe transaction must NOT include alcohol anywhere, and must contain merchant_name somewhere<\/span><\/td>\n<\/tr>\n
VoucherType<\/span><\/td>\n\u00a0<\/span><\/td>\n\n

Name of the voucher type<\/span><\/p>\n

Example: Book, Cash<\/span><\/p>\n<\/td>\n<\/tr>\n

VSettle<\/span><\/td>\n\u00a0<\/span><\/td>\n\n

Controls whether the voucher can be settled into the user’s cash balance<\/span><\/p>\n

Example: 1 or empty field<\/span><\/p>\n<\/td>\n<\/tr>\n

WithdrawFee<\/span><\/td>\nstring<\/span><\/td>\n\n

Amount in cents that it costs to withdraw this voucher as cash<\/span><\/p>\n

Example: 900<\/span><\/p>\n<\/td>\n<\/tr>\n

TID<\/span><\/td>\nstring<\/span><\/td>\n\n

TID (Transaction ID) of the executed API call<\/span><\/p>\n

Example: 1234-5678<\/span><\/p>\n<\/td>\n<\/tr>\n

State<\/span><\/td>\nstring<\/span><\/td>\n\n

Transaction state<\/span><\/p>\n

Example: Success, failed<\/span><\/p>\n<\/td>\n<\/tr>\n

Status<\/span><\/td>\nstring<\/span><\/td>\n\n

Transaction status<\/span><\/p>\n

Example: 1 for success<\/span><\/p>\n<\/td>\n<\/tr>\n

Error<\/span><\/td>\nstring<\/span><\/td>\n\n

Failure reason if applicable as notated<\/span><\/p>\n

Example: Not a valid customer<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Response Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

{<\/span><\/p>\n

\u00a0\u00a0\u00a0 “AutoLock”: “”, <\/span><\/p>\n

\u00a0\u00a0\u00a0 “VoucherNO”: “35291584356847”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “Locked”: “”, <\/span><\/p>\n

\u00a0\u00a0\u00a0 “Title”: “”, <\/span><\/p>\n

\u00a0\u00a0\u00a0 “PIN”: “”, <\/span><\/p>\n

\u00a0\u00a0\u00a0 “Amount”: “900”, <\/span><\/p>\n

\u00a0\u00a0\u00a0 “ThirdPartyClear”: “”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “ThirdParty”: “”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TransactionOverrides”: “”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “VAccumulate”: “1\u201d,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “VMetadata”: “Contains![alcohol] Contains[merchant_name]”, <\/span><\/p>\n

\u00a0\u00a0\u00a0 “VoucherType”: “Book”, <\/span><\/p>\n

\u00a0\u00a0\u00a0 “VSettle”: “”, <\/span><\/p>\n

\u00a0\u00a0\u00a0 “WithdrawFee”: “900”, <\/span><\/p>\n

“Metadata”: “{\\”ActionID\\”: \\”b37beb5b-e5d5-495c-8525-90b275ff4310\\”}”<\/p>\n

“TID”: “1726656166”, <\/span><\/p>\n

\u00a0 \u00a0\u00a0“State”: “Success”,<\/span><\/p>\n

\u00a0\u00a0 \u00a0“Status”: “1”,<\/span><\/p>\n

\u00a0 \u00a0\u00a0“Error”: “”<\/span><\/p>\n

}<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][\/et_pb_accordion][et_pb_text module_id=”ViewVoucherType” _builder_version=”4.20.0″ text_font=”Nunito Sans||||||||” text_text_color=”#959baf” text_font_size=”18px” text_line_height=”1.8em” header_font=”||||||||” header_2_font=”Nunito Sans|700|||||||” header_2_text_color=”#535b7c” header_2_font_size=”35px” header_2_line_height=”1.3em” header_3_font=”Nunito Sans|700|||||||” header_3_text_color=”#535b7c” header_3_font_size=”25px” header_3_line_height=”1.3em” max_width=”700px” module_alignment=”center” global_colors_info=”{}”]<\/p>\n

26 – View Voucher Type<\/h3>\n

[\/et_pb_text][et_pb_accordion open_toggle_background_color=”#ffffff” closed_toggle_background_color=”#ffffff” icon_color=”rgba(83,91,124,0.4)” _builder_version=”4.20.0″ toggle_text_color=”#535b7c” toggle_level=”h3″ toggle_font=”Roboto Mono|700|||||||” toggle_text_align=”left” toggle_font_size=”18px” body_font=”Roboto Mono||||||||” body_text_color=”#989db0″ body_font_size=”13px” custom_margin=”||100px|” custom_padding=”|||” border_radii=”on|4px|4px|4px|4px” border_width_all=”0px” border_color_all=”#d9d9d9″ border_style_all=”solid” box_shadow_style=”preset3″ box_shadow_color=”rgba(34,56,101,0.12)” use_border_color=”on” border_width=”0px” global_colors_info=”{}”][et_pb_accordion_item title=” Description” open=”on” _builder_version=”4.20.0″ global_colors_info=”{}”]<\/p>\n

Use this call to pull the voucher type details.<\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Resource URL” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

https:\/\/{BaseURL}\/viewVoucherType?ns={{namespace}}<\/a><\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” viewVoucherType Request” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n\n
Name<\/span><\/td>\nType<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n<\/thead>\n
VoucherType<\/span><\/td>\nstring<\/span><\/td>\n\n

Name of the voucher type<\/span><\/p>\n

Example: Book, Cash<\/span><\/p>\n<\/td>\n<\/tr>\n

Metadata<\/span><\/td>\nstring<\/span><\/td>\n\n

Any other detail that this transaction needs<\/span><\/p>\n

Example: Teller name<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” Request Header” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

Authorization: {{bearertoken}} <\/span><\/p>\n

Content-Type: application\/json<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” Request Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

{<\/span><\/p>\n

\u00a0\u00a0\u00a0 “VoucherType”: “Book”,<\/span><\/p>\n

“Metadata”: “{\\”ActionID\\”: \\”b37beb5b-e5d5-495c-8525-90b275ff4310\\”}”<\/p>\n

}<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” viewVoucher Response” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Name<\/td>\nType<\/td>\nDescription<\/td>\n<\/tr>\n
AutoLock<\/span><\/td>\nstring<\/span><\/td>\n\n

Controls whether the voucher is relocked automatically on-spend<\/span><\/p>\n

Example: 1 or empty field<\/span><\/p>\n<\/td>\n<\/tr>\n

Locked<\/span><\/td>\nstring<\/span><\/td>\n\n

Controls whether new vouchers are locked by default<\/span><\/p>\n

Example: 1 or empty field<\/span><\/p>\n<\/td>\n<\/tr>\n

PIN<\/span><\/td>\nstring<\/span><\/td>\nAny value; The PIN of the voucher must be empty to spend, via \/updateVoucher (meaning PIN validation must be done externally before clearing it via API)<\/span><\/td>\n<\/tr>\n
ThirdParty<\/span><\/td>\nint<\/span><\/td>\nAny value (usually MSISDN); The ThirdPartyClear field of the voucher must match the value placed here, via \/updateVoucher<\/span><\/td>\n<\/tr>\n
TransactionOverrides<\/span><\/td>\n\u00a0<\/span><\/td>\n\u00a0<\/span><\/td>\n<\/tr>\n
VAccumulate<\/span><\/td>\nstring<\/span><\/td>\n\n

Controls whether new vouchers of this type are accumulated, or created standalone alongside each other<\/span><\/p>\n

Example: 1 or empty field<\/span><\/p>\n<\/td>\n<\/tr>\n

VMetadata<\/span><\/td>\n\u00a0<\/span><\/td>\nThe transaction must NOT include alcohol anywhere, and must contain merchant_name somewhere<\/span><\/td>\n<\/tr>\n
VoucherType<\/span><\/td>\n\u00a0<\/span><\/td>\n\n

Name of the voucher type<\/span><\/p>\n

Example: Book, Cash<\/span><\/p>\n<\/td>\n<\/tr>\n

VSettle<\/span><\/td>\n\u00a0<\/span><\/td>\n\n

Controls whether the voucher can be settled into the user’s cash balance<\/span><\/p>\n

Example: 1 or empty field<\/span><\/p>\n<\/td>\n<\/tr>\n

WithdrawFee<\/span><\/td>\nstring<\/span><\/td>\n\n

Amount in cents that it costs to withdraw this voucher as cash<\/span><\/p>\n

Example: 900<\/span><\/p>\n<\/td>\n<\/tr>\n

TID<\/span><\/td>\nstring<\/span><\/td>\n\n

TID (Transaction ID) of the executed API call<\/span><\/p>\n

Example: 1234-5678<\/span><\/p>\n<\/td>\n<\/tr>\n

State<\/span><\/td>\nstring<\/span><\/td>\n\n

Transaction state<\/span><\/p>\n

Example: Success, failed<\/span><\/p>\n<\/td>\n<\/tr>\n

Status<\/span><\/td>\nstring<\/span><\/td>\n\n

Transaction status<\/span><\/p>\n

Example: 1 for success<\/span><\/p>\n<\/td>\n<\/tr>\n

Error<\/span><\/td>\nstring<\/span><\/td>\n\n

Failure reason if applicable as notated<\/span><\/p>\n

Example: Not a valid customer<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” Response Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

{<\/span><\/p>\n

\u00a0\u00a0\u00a0 “AutoLock”: “”, <\/span><\/p>\n

\u00a0\u00a0\u00a0 “Locked”: “”, <\/span><\/p>\n

\u00a0\u00a0\u00a0 “PIN”: “”, <\/span><\/p>\n

\u00a0\u00a0\u00a0 “ThirdParty”: “”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “TransactionOverrides”: “”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “VAccumulate”: “1\u201d,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “VMetadata”: “Contains![alcohol] Contains[merchant_name]”, <\/span><\/p>\n

\u00a0\u00a0\u00a0 “VoucherType”: “Book”, <\/span><\/p>\n

\u00a0\u00a0\u00a0 “VSettle”: “”, <\/span><\/p>\n

\u00a0\u00a0\u00a0 “WithdrawFee”: “900”, <\/span><\/p>\n

\u00a0\u00a0\u00a0 “TID”: “1726656166”, <\/span><\/p>\n

\u00a0\u00a0\u00a0 “State”: “Success”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “Status”: “1”,<\/span><\/p>\n

\u00a0\u00a0\u00a0 “Error”: “”<\/span><\/p>\n

}<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][\/et_pb_accordion][et_pb_text module_id=”ViewVoucherTypeMerchants” _builder_version=”4.20.0″ text_font=”Nunito Sans||||||||” text_text_color=”#959baf” text_font_size=”18px” text_line_height=”1.8em” header_font=”||||||||” header_2_font=”Nunito Sans|700|||||||” header_2_text_color=”#535b7c” header_2_font_size=”35px” header_2_line_height=”1.3em” header_3_font=”Nunito Sans|700|||||||” header_3_text_color=”#535b7c” header_3_font_size=”25px” header_3_line_height=”1.3em” max_width=”700px” module_alignment=”center” global_colors_info=”{}”]<\/p>\n

27 – View Voucher Type Merchants<\/h3>\n

[\/et_pb_text][et_pb_accordion open_toggle_background_color=”#ffffff” closed_toggle_background_color=”#ffffff” icon_color=”rgba(83,91,124,0.4)” _builder_version=”4.20.0″ toggle_text_color=”#535b7c” toggle_level=”h3″ toggle_font=”Roboto Mono|700|||||||” toggle_text_align=”left” toggle_font_size=”18px” body_font=”Roboto Mono||||||||” body_text_color=”#989db0″ body_font_size=”13px” custom_margin=”||100px|” custom_padding=”|||” border_radii=”on|4px|4px|4px|4px” border_width_all=”0px” border_color_all=”#d9d9d9″ border_style_all=”solid” box_shadow_style=”preset3″ box_shadow_color=”rgba(34,56,101,0.12)” use_border_color=”on” border_width=”0px” global_colors_info=”{}”][et_pb_accordion_item title=” Description” open=”on” _builder_version=”4.20.0″ global_colors_info=”{}”]<\/p>\n

Use this call to pull the list of merchants linked to a voucher type.<\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” Resource URL” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

https:\/\/{BaseURL}\/viewVoucherType?ns={{namespace}}<\/a><\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” viewVoucherType Request” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n\n
Name<\/span><\/td>\nType<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n<\/thead>\n
VoucherType<\/span><\/td>\nstring<\/span><\/td>\n\n

Name of the voucher type<\/span><\/p>\n

Example: Book, Cash<\/span><\/p>\n<\/td>\n<\/tr>\n

Metadata<\/span><\/td>\nstring<\/span><\/td>\n\n

Any other detail that this transaction needs<\/span><\/p>\n

Example: Teller name<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” Request Header” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

Authorization: {{bearertoken}} <\/span><\/p>\n

Content-Type: application\/json<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” Request Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

{<\/span><\/p>\n

\u00a0\u00a0\u00a0 “VoucherType”: “Book”,<\/span><\/p>\n

“Metadata”: “{\\”ActionID\\”: \\”b37beb5b-e5d5-495c-8525-90b275ff4310\\”}”<\/p>\n

}<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” viewVoucherTypeMerchants Response” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n\n\n\n\n\n\n
Name<\/span><\/td>\nType<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n<\/thead>\n
TID<\/span><\/td>\nInteger<\/span><\/td>\n\n

TID (Transaction ID) of the executed API call<\/span><\/p>\n

Example: 1234-5678<\/span><\/p>\n<\/td>\n<\/tr>\n

Merchants<\/span><\/td>\nstring<\/span><\/td>\nMerchants name<\/span><\/td>\n<\/tr>\n
State<\/span><\/td>\nstring<\/span><\/td>\n\n

Transaction state<\/span><\/p>\n

Example: Success, failed<\/span><\/p>\n<\/td>\n<\/tr>\n

Status<\/span><\/td>\nstring<\/span><\/td>\n\n

Transaction status<\/span><\/p>\n

Example: 1 for success<\/span><\/p>\n<\/td>\n<\/tr>\n

Error<\/span><\/td>\nstring<\/span><\/td>\n\n

Failure reason if applicable as notated<\/span><\/p>\n

Example: Not a valid customer<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=” Response Body” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n\n\n\n
\n

{<\/span><\/p>\n

\u00a0 “TID”: “98325242”,<\/span><\/p>\n

\u00a0 “Merchants”: “”,<\/span><\/p>\n

\u00a0 “State”: “Success”,<\/span><\/p>\n

\u00a0 “Status”: “1”,<\/span><\/p>\n

\u00a0 “Error”: “”<\/span><\/p>\n

}<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

 <\/p>\n

[\/et_pb_accordion_item][\/et_pb_accordion][et_pb_text module_id=”HTTPAPI” _builder_version=”4.20.0″ text_font=”Nunito Sans||||||||” text_text_color=”#959baf” text_font_size=”18px” text_line_height=”1.8em” header_font=”||||||||” header_2_font=”Nunito Sans|700|||||||” header_2_text_color=”#535b7c” header_2_font_size=”35px” header_2_line_height=”1.3em” header_3_font=”Nunito Sans|700|||||||” header_3_text_color=”#535b7c” header_3_font_size=”25px” header_3_line_height=”1.3em” max_width=”700px” module_alignment=”center” global_colors_info=”{}”]<\/p>\n

E) HTTP Status Codes and Error Codes<\/strong><\/span><\/h1>\n

[\/et_pb_text][et_pb_accordion open_toggle_background_color=”#ffffff” closed_toggle_background_color=”#ffffff” icon_color=”rgba(83,91,124,0.4)” _builder_version=”4.20.0″ toggle_text_color=”#535b7c” toggle_level=”h3″ toggle_font=”Roboto Mono|700|||||||” toggle_text_align=”left” toggle_font_size=”18px” body_font=”Roboto Mono||||||||” body_text_color=”#989db0″ body_font_size=”13px” custom_margin=”||100px|” custom_padding=”|||” border_radii=”on|4px|4px|4px|4px” border_width_all=”0px” border_color_all=”#d9d9d9″ border_style_all=”solid” box_shadow_style=”preset3″ box_shadow_color=”rgba(34,56,101,0.12)” use_border_color=”on” border_width=”0px” locked=”off” global_colors_info=”{}”][et_pb_accordion_item title=”HTTP status codes” open=”on” _builder_version=”4.20.0″ global_colors_info=”{}”]<\/p>\n

The following codes represent a subset of common HTTP status codes and is not a comprehensive list of all codes.<\/p>\n\n\n\n\n\n\n\n\n\n
Code<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n
200<\/span><\/td>\nRequest OK<\/span><\/td>\n<\/tr>\n
201<\/span><\/td>\nResource created<\/span><\/td>\n<\/tr>\n
401<\/span><\/td>\nUnauthorized request<\/span><\/td>\n<\/tr>\n
402<\/span><\/td>\nFailed request<\/span><\/td>\n<\/tr>\n
404<\/span><\/td>\nResource was not found<\/span><\/td>\n<\/tr>\n
50x<\/span><\/td>\nCelbux server error<\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”API ERROR Codes” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]The following list of errors are related to the OAuth API\u2019s listed within this document.<\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Code<\/span><\/td>\nShort Description<\/span><\/td>\nDescription<\/span><\/td>\n<\/tr>\n
-1<\/span><\/td>\nAuthorization failed<\/td>\nThe bearer token provided is invalid.<\/td>\n<\/tr>\n
-2<\/span><\/td>\nDuplicate reference<\/td>\nThe transaction failed because the reference number used already exits.<\/td>\n<\/tr>\n
-3<\/span><\/td>\nInvalid request<\/td>\nThe request was in an invalid format.<\/td>\n<\/tr>\n
-4<\/span><\/td>\nInvalid MEID<\/td>\nThe MEID (Merchant Encrypted ID) was invalid.<\/td>\n<\/tr>\n
-5<\/span><\/td>\nConnection Error<\/td>\nA connection error has occurred, please try again.<\/td>\n<\/tr>\n
-6<\/span><\/td>\nInvalid TID<\/td>\nThe TID (Transaction ID) was invalid.<\/td>\n<\/tr>\n
-7<\/span><\/td>\nTransaction Failed General<\/td>\nThe transaction failed for unspecified reason.<\/td>\n<\/tr>\n
-8<\/span><\/td>\nInvalid Currency<\/td>\nThe currency code was invalid.<\/td>\n<\/tr>\n
-12<\/span><\/td>\nTransaction Failed Insufficient funds<\/td>\nThe transaction failed as there were insufficient funds available on the voucher.<\/td>\n<\/tr>\n
-13<\/span><\/td>\nTransaction Failed Wrong Merchant<\/td>\nThe transaction failed as it is not valid to be spent at current merchant.<\/td>\n<\/tr>\n
-14<\/span><\/td>\nTransaction Failed Incorrect Voucher Number<\/td>\nThe transaction failed as the voucher does not exist.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

[\/et_pb_accordion_item][\/et_pb_accordion][\/et_pb_column][\/et_pb_row][\/et_pb_section][et_pb_section fb_built=”1″ admin_label=”Request a Feature” _builder_version=”4.16″ custom_padding=”6px|0px|100px|0px||” saved_tabs=”all” global_colors_info=”{}”][et_pb_row use_custom_gutter=”on” gutter_width=”2″ _builder_version=”4.20.0″ custom_padding=”87px|||||” global_colors_info=”{}”][et_pb_column type=”4_4″ _builder_version=”4.16″ background_color_gradient_direction=”243deg” background_color_gradient_start=”#3D72E7″ background_color_gradient_end=”#53a0fe” custom_padding=”|||” global_colors_info=”{}” custom_padding__hover=”|||”][et_pb_text module_id=”frequently” _builder_version=”4.20.0″ text_font=”Nunito Sans||||||||” text_text_color=”#959baf” text_font_size=”18px” text_line_height=”1.8em” header_font=”||||||||” header_2_font=”Nunito Sans|700|||||||” header_2_text_color=”#535b7c” header_2_font_size=”35px” header_2_line_height=”1.3em” header_3_font=”Nunito Sans|700|||||||” header_3_text_color=”#535b7c” header_3_font_size=”25px” header_3_line_height=”1.3em” max_width=”700px” module_alignment=”center” global_colors_info=”{}”]<\/p>\n

Frequently Asked Questions<\/span><\/strong><\/h3>\n

The purpose of this section is to address questions that may arise before or during merchant integration.<\/p>\n

[\/et_pb_text][et_pb_accordion open_toggle_background_color=”#ffffff” closed_toggle_background_color=”#ffffff” icon_color=”rgba(83,91,124,0.4)” _builder_version=”4.20.0″ toggle_text_color=”#535b7c” toggle_level=”h3″ toggle_font=”Roboto Mono|700|||||||” toggle_text_align=”left” toggle_font_size=”18px” body_font=”Roboto Mono||||||||” body_text_color=”#989db0″ body_font_size=”13px” custom_margin=”||100px|” custom_padding=”|||” border_radii=”on|4px|4px|4px|4px” border_width_all=”0px” border_color_all=”#d9d9d9″ border_style_all=”solid” box_shadow_style=”preset3″ box_shadow_color=”rgba(34,56,101,0.12)” use_border_color=”on” border_width=”0px” global_colors_info=”{}”][et_pb_accordion_item title=”What is a Bearer Token?” open=”on” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}”]<\/p>\n

A security token which should be placed in the header of the REST API call under authorization.<\/p>\n

One will be provided by Celbux for testing and a second token will be provided for the production environment once testing has been concluded and signed off.<\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”What is the difference between POST HTTP method and GET HTTP method?” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

The GET method is used to request data from a specified resource. The POST method is used to send data to a server to create\/update a resource.<\/p>\n

Note: Transactional API calls are in POST HTTP method and reporting API calls are in GET and POST HTTP method.<\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”What is an MEID?” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

The MEID is the Merchant Encrypted ID number generated by the system when the merchant account is created on the Celbux platform.<\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”What is a StoreID?” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

The Store ID is supplied by the merchant, pointing to a single Celbux merchant account. The StoreID is a required field in order to identify a specific store.<\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”Should I use StoreID or MEID?” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

Either the MEID or the StoreID is required to identify the merchant. If both are supplied, the system will use the MEID and ignore the StoreID.<\/p>\n

Note: The MEID is not required if the merchant is created on multiple platforms or loaded on the Celbux Merchant Exchange.<\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”What is a Reference number?” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

The Reference Number is a unique transaction reference number given by the merchant to identify a transaction. The Reference Number is a mandatory field. If no Reference Number is available, use a Time Stamp as the Reference Number.<\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”What is a TID?” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

Transaction Identifier (TID) is automatically generated by the Celbux system after a successful transaction API call occurs. The TID is required for reversal API calls such as Confirm, Reverse, Refund, Refund1 and Refund2 API calls.<\/p>\n

[\/et_pb_accordion_item][et_pb_accordion_item title=”What format do I use the voucher number in the API call?” _builder_version=”4.20.0″ _module_preset=”default” global_colors_info=”{}” open=”off”]<\/p>\n

The voucher number is thirteen characters long and can be used with the dashes or without the dashes.<\/p>\n

[\/et_pb_accordion_item][\/et_pb_accordion][\/et_pb_column][\/et_pb_row][\/et_pb_section]<\/p>\n","protected":false},"excerpt":{"rendered":"

OAuth 2.0 API Merchant API Administrative API Integration SpecificationCelbux API Call Structure Type Resource URL Request Response\u00a0OAuth 2.0 API Integration Information – Important Introduction 1- Environments Please note 2- createUserVoucher Description Resource URL createUserVoucherRequest Request Header Request Body createUserVoucherResponse Response Body 3 -eftOut Description Resource URL eftOutRequest Request Header Request Body eftOut Response Response Body […]<\/p>\n","protected":false},"author":2,"featured_media":0,"parent":0,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"_et_pb_use_builder":"on","_et_pb_old_content":"","_et_gb_content_width":"","_monsterinsights_skip_tracking":false,"_monsterinsights_sitenote_active":false,"_monsterinsights_sitenote_note":"","_monsterinsights_sitenote_category":0},"aioseo_notices":[],"_links":{"self":[{"href":"https:\/\/yournewsite.cardboardstory.com\/index.php\/wp-json\/wp\/v2\/pages\/363"}],"collection":[{"href":"https:\/\/yournewsite.cardboardstory.com\/index.php\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/yournewsite.cardboardstory.com\/index.php\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/yournewsite.cardboardstory.com\/index.php\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/yournewsite.cardboardstory.com\/index.php\/wp-json\/wp\/v2\/comments?post=363"}],"version-history":[{"count":80,"href":"https:\/\/yournewsite.cardboardstory.com\/index.php\/wp-json\/wp\/v2\/pages\/363\/revisions"}],"predecessor-version":[{"id":618,"href":"https:\/\/yournewsite.cardboardstory.com\/index.php\/wp-json\/wp\/v2\/pages\/363\/revisions\/618"}],"wp:attachment":[{"href":"https:\/\/yournewsite.cardboardstory.com\/index.php\/wp-json\/wp\/v2\/media?parent=363"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}