balance-enquiry - PayCloud SaaS

This method receives the balance information in ECW for any subscriber/agent/Merchant registered in ECW.How ever for agent since multiple accounts (Commission) will be linked it is suggested to use accountDetails API..Please note that this API will not return Comission Balance

请求参数

Body 参数application/json

senderIdentifier

string

senderIdentifier

必需

A valid identity associated with the account holder, either an agent, currently there is no character limit Id or msisdn e.g. 27785556985

string

可选

Pin of the agent/subscriber initiating the transaction.Length 5 and it will be validated at SOA

sessionId

string

sessionId

可选

SessionId that is generated after successful login into Mobile Money Platform. Source Channels needs to capture this sessionId after succesful login and then it needs to be sent for the subsequent requests

quoteId

string

quoteId

可选

Unique ID of quote which is generated for any financial transaction, in future if balance enquiry is charged this will be used

示例

{
    "senderIdentifier": "string",
    "pin": "string",
    "sessionId": "string",
    "quoteId": "string"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

code

string

错误码

必需

0：表示成功，其他表示失败

msg

string

错误描述

必需

psn

string

报文序列号

必需

data

object

业务数据

必需

balance

string

balance

必需

The current balance in ECW. It may or may not include the totalReservation at one point of time(before approval), totalReservation once approved will get added to the balance.

committedBalance

string

committedBalance

必需

The committed balance in ECW, same as balance

totalReservation

string

totalReservation

必需

The total reserved balance on the account, .i.e, the amount which is pending for approval from the system, once approved it will get added to the balance

totalPositiveReservation

string

totalPositiveReservation

必需

The positive reserved balance on the account. e.g. cash-out with otp. When agent performs cash out and wait for subscriber to approve it, amount is kept as “reserved”. This will be positive amount

currencyOfTransaction

string

currencyOfTransaction

必需

Currency for the transaction e.g. ZAR

loyalty

object

loyalty

必需

示例

{
    "code": "string",
    "msg": "string",
    "psn": "string",
    "data": {
        "balance": "string",
        "committedBalance": "string",
        "totalReservation": "string",
        "totalPositiveReservation": "string",
        "currencyOfTransaction": "string",
        "loyalty": {
            "amountConsumed": "string",
            "newBalanceAmount": "string",
            "loyaltyAmountGenerated": "string"
        }
    }
}