Balance Inquiry

Specification

The Following tabel is spesification for this API :

API Name	Balance Inquiry
Function	This API is used to query Paydia Bisnis and Paydia App's balance via merchant
Service Code	11
Method	POST
URL	/snap/v1.0/balance-inquiry
Accept	application/json
Content Type	application/json
Related Service	Balance Inquiry

Request

The following part will be describe about parameter of request in this API:

Request Parameter

The following table is a list of request parameter in this API:

Header

The following table is Header of Request Parameters :

No	Name	Type	Length	Required	Condition	Remarks
1	Content-Type	String	Variable, 127 max	Mandatory	-	Content type, value always application/json
2	Authorization	String	Variable	Mandatory	-	Contains B2B Bearer JWT Token, you've got it from Access Token B2B
3	Authorization-Customer	String	Variable, 64 max	Conditional	If you want to check Paydia app's balance via merchant	Contains customer token, you've got it from Access Token B2B2C
4	X-TIMESTAMP	String	Fixed, 25 max	Mandatory	-	Transaction date time, in format YYYY-MM-DDTHH:mm:ss+07:00. Time must be in GMT+7 (Jakarta time)
5	X-PARTNER-ID	String	Variable, 36 max	Mandatory	-	ID for partner was generated by Paydia. Unique ID for a partner
6	X-EXTERNAL-ID	String	Variable, 36 max	Mandatory	-	Unique messaging reference ID generated by merchant. Numeric String. Reference number that should be unique in the same day
7	CHANNEL-ID	String	Variable, 5 max	Mandatory	-	Device identification on which the API services is currently being accessed by the end user (customer)
8	X-SIGNATURE	String	Variable	Mandatory	-	Signature need to be generated with Symmetric Signature method

Body

The following table is a body of request parameter:

No	Name	Type	Length	Required	Condition	Remarks
1	partnerReferenceNo	String	Variable, 64 max	Mandatory	-	Unique transaction identifier on partner system which assigned to each transaction
2	accountNo	String	variable, 16 max	Conditional	Must be filled if Authorization-Customer is Null (query balance of Paydia Bisnis)	Merchant identifier that is unique per each merchant
3	balanceTypes	Array of String	Variable	Optional	-	Always have value of CASH

Request Sample

The following script is a request sample of this API:

POST /snap/v1.0/balance-inquiry
X-TIMESTAMP: 2024-08-02T16:17:17+07:00
X-PARTNER-ID: 4abbcb6ce30229994c76169006e0dc9c
X-SIGNATURE: /JEzrYoUSuSpNtdqkOMdJlLVnH/ih4JNa4X660dhGxEfvSNVJDePqzPffrJPE2838/Yj3UmkpA3gRzIKfCrUjA==
X-EXTERNAL-ID: 1722615445
CHANNEL-ID: 12345
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJQYXlkaWEiLCJpYXQiOjE3MjI2MTQ4OTIsImV4cCI6MTcyMjcwMTI5MiwiZGF0YSI6eyJlbnYiOiJwcm9kdWN0aW9uIn19.l_To-VKXxMqP_fcls6D0JbaLeJX_a1Oq6h59EauNK1s

{
    "partnerReferenceNo": "4f3b7b62-1b10-4b01-aac2-6267a82e8295",
    "accountNo": "240327001000000",
    "balanceTypes": ["Cash"]
}

Response

The following part will be describe about parameter of response in this API:

Response Parameter

The following table is a list of response parameter in this API:

Body

The following table is a body of response parameter:

No	Name	Type	Length	Required	Condition	Remarks
1	responseCode	String	Fixed, 7 max	Mandatory	-	Refer to response code list
2	responseMessage	String	Variable, 150 max	Mandatory	-	Refer to response code list
3	referenceNo	String	Variable, 64 max	Optional	-	Transaction identifier on Paydia
4	partnerReferenceNo	String	Variable, 64 max	Mandatory	-	Unique transaction identifier on partner system which assigned to each transaction
5	accountNo	String	Variable, 32 max	Mandatory	-	Registered account number
6	name	String	Variable, 140 max	Mandatory	-	Customer account name
7	accountInfo	Array of Object	Variable	Mandatory	-	List, e.g. BALANCE, CASH, QRIS, POINTS, etc
8	accountInfo.balanceType	String	Variable, 70 max	Optional	-	To specify which balance type expected to be returned. Will return all available balance type if this parameter empty
9	accountInfo.amount	Money	Variable	Mandatory	-	List, net active amount, contains two sub-fields: Value: Transaction amount, including the cents Currency: Currency code based on ISO
10	accountInfo.status	String	Variable, 4 max	Optional	-	Account status: 0001 = Active Account 0002 = Closed Account 0004 = New Account 0006 = Restricted Account 0007 = Frozen Account

Response Sample

The following script is a response sample of this API:

{
    "responseCode": "2001100",
    "responseMessage": "Successful",
    "referenceNo": "dtFPlOFawRO0OLmr",
    "partnerReferenceNo": "4f3b7b62-1b10-4b01-aac2-6267a82e8295",
    "accountNo": "240327001000000",
    "name": "Firman Zain",
    "accountInfo": [
        {
            "balanceType": "Cash",
            "amount": {
                "value": "19787531.00",
                "currency": "IDR"
            },
            "status": "0001"
        }
    ]
}

Response Code and Message

The following table is the list response code and message of Balance Inquiry API:

No	Response Code	Response Message	Remarks
1	2001100	Successful	Success to be processed
2	4001101	Invalid Field Format	Invalid format for certain field
3	4001102	Invalid Mandatory Field	Missing or invalid format on mandatory field
4	4011100	Unauthorized. [reason]	General unauthorized error
5	4011101	Invalid Token (B2B)	Invalid or Expired Access Token
6	4091100	Conflict	Cannot use same X-EXTERNAL-ID in same day
7	4091101	Duplicate partnerReferenceNo	Duplicate partnerReferenceNo
8	5001102	Backend system failure	500 internal server error