Account Details

Before initiating a transaction, TSP users can use this API to check the account balance on the ledger.

Endpoint

Method: POST
URL: {{URL}}/gw/billpay/BillerTransactionService/AccountDetails

Headers

Key	Type	Required	Description
Content-Type	string	Yes	application/json
Signature	string	Yes	{{Signature}}
Authorization	string	Yes	{{Credential}}

---

Request

{
     "api": {
        "apiKey": "0b46634e3aac44109ac75e6bf3177fd6",
        "reference": "REFTSPBILLPAY240328000006"
    },
    "tspCustomerId": "100000000001002",
    "customerId": "100000000001002",
    "accountId": "200970210964318",
    "transactionType": "ACCT_DETAILS",
    "transactionDateTime": "1665763797896",
    "product": "RPPS",
    "program": "BILL_PAY",
    "source": "TSP"
}

Response: 200

Request Parameters

Parameter	Description
apiKey Mandatory	String API key for authentication
reference Mandatory	String Unique request identifier
tspCustomerId Mandatory	String Customer ID
customerId Mandatory	String Customer ID
accountId Mandatory	String Customer account ID
transactionType Mandatory	String Transaction type Constant: ACCT_DETAILS
transactionDateTime Mandatory	String Unix timestamp
product Mandatory	String Product Constant: RPPS
program Mandatory	String Program Constant: BILL_PAY
source Mandatory	String Source Constant: TSP

{
    "api": {
        "apiKey": "16c883cbf4a44bd0acd6b4d3ac80a602",
        "reference": "REFTSPBILLPAY240328000006"
    },
    "CustomerId": "100000000000001",
    "status": "000",
    "transactionType": "ACCT_DETAILS",
    "description": "SUCCESS",
    "account": {
        "accountId": "200931384666635",
        "balanceCents": "782793"
    }
}