transaction-history - PayCloud SaaS

This method is used to get a list of transactions performed by the consumer

请求参数

Body 参数application/json

senderIdentifier

string

senderIdentifier

必需

A valid identity associated with the initiator, either an agent Id or an msisdn e.g. 27785556985(Country code and then the number i.e. international format)

externalTransactionId

string

externalTransactionId

可选

Cash-Out Card to wallet, Bank to Wallet, Instand EFT to Wallet and OZOW to Wallet.

receiverIdentifier

string

receiverIdentifier

可选

A valid identity associated with the receiver, either an agent Id or an msisdn e.g. 27785556985(Country code and then the number)

string

可选

MoMo Pin need to be passed

sessionId

string

sessionId

可选

Session ID need to be passed

noOfTransactions

integer

noOfTransactions

可选

Number of transactions done. Either this parameter is mandatory or startDate and endDate is mandatory.

indexOffset

integer

indexOffset

必需

Start retrieving transaction history from this index

startDate

string

startDate

可选

Start date of the period that consumer want to view transaction history. Either noOfTransactions parameter is mandatory or startDate and endDate is mandatory.

endDate

string

endDate

可选

End date of the period that consumer want to view transaction history. Either noOfTransactions parameter is mandatory or startDate and endDate is mandatory.

transactionStatus

string

transactionStatus

必需

The status of the committed transaction.Possible Values are SUCCESSFUL,PENDING,FAILED and ALL.

transactionType

string

transactionType

可选

filter

string

filter

可选

Number of transactions done. Either this parameter is mandatory or startDate and endDate is mandatory.

providerSystem

string

providerSystem

可选

Name of the Provider to check the transaction. If want to check the Loyalty transaction then YelloBucks else ECW

示例

{
    "senderIdentifier": "string",
    "externalTransactionId": "string",
    "receiverIdentifier": "string",
    "pin": "string",
    "sessionId": "string",
    "noOfTransactions": 0,
    "indexOffset": 0,
    "startDate": "string",
    "endDate": "string",
    "transactionStatus": "string",
    "transactionType": "string",
    "filter": "string",
    "providerSystem": "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

业务数据

必需

transactionDetails

array [object {21}]

transactionDetails

可选

Details of the transaction

statusCode

string

Status of the transaction ;0- Success,Any value other than 0- Failure

必需

statusMessage

string

Status of the transaction, which will indicate if it is success or failure. If business failure, the reason for the failure will be displayed

必需

supportMessage

string

Support message for the transaction. Indicates failure reason in case of failed transactions

必需

transactionId

string

Unique identifier for every request to SOA. Mapped from input request

必需

示例

{
    "code": "string",
    "msg": "string",
    "psn": "string",
    "data": {
        "transactionDetails": [
            {
                "receiverIdentifier": "string",
                "senderName": "string",
                "transactionFee": "string",
                "senderIdentifier": "string",
                "receiverName": "string",
                "transactionAmount": "string",
                "crIndicator": "string",
                "currency": "string",
                "externalTransactionId": "string",
                "transactionDate": "string",
                "financialTransactionId": "string",
                "availableBalance": "string",
                "recipientMsisdn": "string",
                "isReversable": true,
                "transactionType": "string",
                "transactionStatus": "string",
                "userId": "string",
                "providerName": "string",
                "voucherId": "string",
                "voucherExpireDate": "string",
                "additionalInfo": {}
            }
        ],
        "statusCode": "string",
        "statusMessage": "string",
        "supportMessage": "string",
        "transactionId": "string"
    }
}