Inquiry Status VA

Specification

The Following tabel is spesification for this API :

API Name	Inquiry Status VA
Function	This API is used to inquiry the status of created virtual account (VA)
Service Code	26
Method	POST
URL	/snap/v1.0/transfer-va/inquiry-status
Accept	application/json
Content Type	application/json
Related Service	Virtual Account

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	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)
4	X-PARTNER-ID	String	Variable, 36 max	Mandatory	-	ID for partner was generated by Paydia. Unique ID for a partner
5	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
6	CHANNEL-ID	String	Variable, 5 max	Mandatory	-	Device identification on which the API services is currently being accessed by the end user (customer)
7	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	partnerServiceId	String	Fixed, 8 max	Mandatory	-	Biller/merchant code of the virtual account. Left padding with space
2	customerNo	String	Variable, 20 max	Mandatory	-	Unique number (up to 20 digits). Combine partnerServiceId and customerNo or virtualAccountNo
3	virtualAccountNo	String	Variable, 28 max	Mandatory	-	Information of virtual account number which combine partnerServiceId and customerNo
4	virtualAccountName	String	Variable, 255 max	Mandatory	-	Information of customer name
5	trxId	String	Variable, 64 max	Mandatory	-	Unique transaction identifier on partner system which assigned to each transaction
6	totalAmount	Money	Variable	Optional	-	Contains two sub-fields: Value: Transaction totalAmount, including the cents Currency: Currency code based on ISO
7	expiredDate	String	Fixed, 25 max	Optional	-	Expiration date for virtual account, in format YYYY-MM-DDTHH:mm:ss+07:00. Time must be in GMT+7 (Jakarta time)
8	additionalInfo	JSON Object	Variable	Optional	-	Additional information
9	additionalInfo.callbackUrl	String	Variable, 8 max	Optional	-	URL to be able to receive payment notifications after payment is made by the customer

Request Sample

The following script is a request sample of this API:

POST /snap/v1.0/transfer-va/inquiry-status
X-TIMESTAMP: 2024-10-10T10:25:33+07:00
X-PARTNER-ID: 35d1a1127182a65e4fe0256242a40a6d
X-SIGNATURE: BlMk6tnvxxR1ktErqJ1Ekanz5XGsEC3Ltjk6bNrEIgqD1T5eQJQDnyN7ryBdq1Xh0F/5DKmxyE4AAzMC3yLKPg==
X-EXTERNAL-ID: 1728531437
CHANNEL-ID: 233
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJQYXlkaWEiLCJpYXQiOjE3Mjg0NjQwNzEsImV4cCI6MTcyODU1MDQ3MSwiZGF0YSI6eyJlbnYiOiJkZXZlbG9wbWVudCJ9fQ.aIG1dMVpKuJT4boLcH-BZoKa0KkrRBSyGb9DNfSWBqI

{
    "partnerServiceId": "  359660",
    "customerNo": "70627627784739813500",
    "virtualAccountNo": "  35966070627627784739813500",
    "inquiryRequestId": "73e6b029-7c33-46a1-843a-4f72d2e1e36d"
}

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	virtualAccountData	JSON Object	Variable	Mandatory	-	Contains virtual account data

Response Sample

The following script is a response sample of this API:

{
    "responseCode": "2002600",
    "responseMessage": "Successful",
    "virtualAccountData": {
        "paymentFlagReason": {
            "english": "Initiated",
            "indonesia": "Dibuat"
        },
        "partnerServiceId": "  359660",
        "customerNo": "70627627784739813500",
        "virtualAccountNo": "  35966070627627784739813500",
        "inquiryRequestId": "73e6b029-7c33-46a1-843a-4f72d2e1e36d",
        "virtualAccountName": "Judah Hartmann",
        "paidAmount": {
            "value": "50000.00",
            "currency": "IDR"
        },
        "paymentFlagStatus": "01",
        "additionalInfo": {
            "callbackUrl": "https://webhook.site/53a58f8e-f254-4154-bab6-d52578c7b4a7"
        }
    }
}

Response Code and Message

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

No	Response Code	Response Message	Remarks
1	2002600	Successful	Success to be processed
2	4002601	Invalid Field Format	Invalid format for certain field
3	4002602	Invalid Mandatory Field	Missing or invalid format on mandatory field
4	4012600	Unauthorized. [reason]	General unauthorized error
5	4012601	Invalid Token (B2B)	Invalid or Expired Access Token
6	4042612	Invalid Bill/Virtual Account	The bill is blocked/ suspended/not found Virtual account is suspend/not found
7	4092600	Conflict	Cannot use same X-EXTERNAL-ID in same day
8	4092601	Duplicate partnerReferenceNo	Duplicate partnerReferenceNo
9	5002602	Backend system failure	500 internal server error