API Services
The header for transaction request
Parameter M/O/C Data Type Description
Parameter M/O/C Data Type Description
Create Virtual Account (VA)
POST /{version}/transfer-va/create-va
The API Virtual Account service creates a VA number for transactions.
Service code: 27
Current version: v1.0
* is required
URL Path
Sandbox: https://debit-sandbox.faspay.co.id/v1.0/transfer-va/create-va
Request Body
402 -> Permata VA (Dynamic)
408 -> Maybank VA (Dynamic)
706 -> Indomaret Payment point (Dynamic)
707 -> Alfagroup (Dynamic)
708 -> Danamon VA (Dynamic)
718 -> BNC VA (Static & Dynamic)
801 -> BNI VA (Static & Dynamic)
802 -> Mandiri VA (Dynamic)
818 -> Sinarmas VA (Dynamic)
837 -> BTN VA (Static & Dynamic)
Response
Create VA - Sample Request Create VA-Sample Response
Copy {
"virtualAccountName" : "Jokul Doe" ,
"virtualAccountEmail" : "jokul@email.com" ,
"virtualAccountPhone" : "6281828384858" ,
"trxId" : "abcdefgh1234" ,
"totalAmount" : {
"value" : "12345678.00" ,
"currency" : "IDR"
} ,
"expiredDate" : "2020-12-31T23:59:59-07:00" ,
"additionalInfo" : {
"billDate" : "2020-12-31T23:59:59-07:00" ,
"channelCode" : "402" ,
"billDescription" : "Maintenance"
}
}
Copy {
"responseCode" : "2002500" ,
"responseMessage" : "Success" ,
"virtualAccountData" : {
"partnerServiceId" : " 088899" ,
"customerNo" : "12345678901234567890" ,
"virtualAccountNo" : "08889912345678901234567890" ,
"virtualAccountName" : "Jokul Doe" ,
"virtualAccountEmail" : "jokul@email.com" ,
"virtualAccountPhone" : "6281828384858" ,
"trxId" : "abcdefgh1234" ,
"totalAmount" : {
"value" : "12345678.00" ,
"currency" : "IDR"
} ,
"expiredDate" : "20201231T235959Z" ,
"additionalInfo" : {
"billDate" : "2020-12-31T23:59:59-07:00" ,
"channelCode" : "402" ,
"billDescription" : "Maintenance" ,
"redirectUrl":"https://dev.faspay.co.id/pws/100003/0830000010100000/5807a17ccd950904ec0a303725fa8a4b36c89e2f?trx_id=9876530200004184&merchant_id=98765&bill_no=98765123456789"
}
} Inquiry
POST /{version}/transfer-va/inquiry
The API Virtual Account Inquiry is used to forward user requests to inquire about specific VA information.
Service Code: 24
Notes: - * is required
- Current version: v1.0
URL Path: urlmerchant + /v1.0/transfer-va/inquiry
(example: merchantkita-sandbox.com/v1.0/transfer-va/inquiry)
Request Body
402 -> Permata VA (Static)
408 -> Maybank VA (Static)
706 -> Indomaret Payment point (Static)
707 -> Alfagroup (Static)
708 -> Danamon VA (Static)
802 -> Mandiri VA (Static)
818 -> Sinarmas VA (Static)
Inquiry Response Parameter
Inquiry-Sample Request Inquiry-Sample Response
Copy {
"partnerServiceId" : " 88899" ,
"customerNo" : "12345678901234567890" ,
"virtualAccountNo" : " 08889912345678901234567890" ,
"inquiryRequestId" : "abcdef-123456-abcdef"
}
Copy {
"responseCode" : "2002400" ,
"responseMessage" : "Success" ,
"virtualAccountData" : {
"partnerServiceId" : " 088899" ,
"customerNo" : "12345678901234567890" ,
"virtualAccountNo" : " 08889912345678901234567890" ,
"virtualAccountName" : "Johnny Suh" ,
"virtualAccountEmail" : "johnnysuh@email.com" ,
"virtualAccountPhone" : "6281828384858" ,
"inquiryRequestId" : "abcdef-123456-abcdef" ,
"totalAmount" : {
"value" : "12345678.00" ,
"currency" : "IDR"
} ,
}
} Payment
POST /{version}/transfer-va/payment
This service is used to notify payment confirmation for specific VA that has been paid.
Service Code: 25
Notes: - * is required
- Current version: v1.0
URL Path : urlmerchant+/v1.0/transfer-va/payment
(example: merchantkita-sandbox.com/v1.0/transfer-va/payment)
Request Body
402 -> Permata VA (Static)
408 -> Maybank VA (Static)
706 -> Indomaret Payment point (Static)
707 -> Alfagroup (Static)
708 -> Danamon VA (Static)
802 -> Mandiri VA (Static)
818 -> Sinarmas VA (Static)
Payment Response Parameter
Payment-Sample Request Payment-Sample Response
Copy {
"partnerServiceId" : " 088899" ,
"customerNo" : "12345678901234567890" ,
"virtualAccountNo" : " 08889912345678901234567890" ,
"paymentRequestId" : "abcdef-123456-abcdef" ,
"paidAmount" : {
"value" : "12345678.00" ,
"currency" : "IDR"
} ,
"trxDateTime" : "20201231T235959Z"
"referenceNo" : "123456789012345"
}
Copy {
"responseCode" : "2002500" ,
"responseMessage" : "Success" ,
"virtualAccountData" : {
"partnerServiceId" : " 088899" ,
"customerNo" : "12345678901234567890" ,
"virtualAccountNo" : " 08889912345678901234567890" ,
"virtualAccountName" : "Johnny Suh" ,
"paymentRequestId" : "abcdef-123456-abcdef" ,
"paidAmount" : {
"value" : "12345678.00" ,
"currency" : "IDR"
}
}
} Inquiry Status
POST /{version}/transfer-va/status
Merchants use this service to check the status of transfers made.
Service code: 26
Current version: v1.0
* is required
URL Path
Sandbox: https://debit-sandbox.faspay.co.id/v1.0/transfer-va/status
Request Body
Inquiry Status Response Parameter
Status Code List
Inquiry Status-Request Sample Inquiry Status-Response Sample
Copy {
"partnerServiceId" : "088899" ,
"customerNo" : 12345678901234567890 ,
"virtualAccountNo" : "08889912345678901234567890" ,
"inquiryRequestId" : "abcdef-123456-abcdef" ,
"additionalInfo" : {
"channelCode" : "402" ,
"trxId" : "9876540000001115"
}
}
Copy {
"responseCode" : "2002600" ,
"responseMessage" : "Success" ,
"virtualAccountData" : {
"paymentFlagReason" : {
"english" : "Success" ,
} ,
"partnerServiceId" : " 088899" ,
"customerNo" : "12345678901234567890" ,
"virtualAccountNo" : " 08889912345678901234567890" ,
"inquiryRequestId" : "abcdef-123456-abcdef" ,
"paymentRequestId" : "abcdef-123456-abcdef" ,
"paidAmount" : {
"value" : "12345678.00" ,
"currency" : "IDR"
} ,
"transactionDate" : "20201231T235959Z" ,
"paymentFlagStatus" : "00" ,
"additionalInfo" : {
"channelCode" : "402"
}
}
} Delete Virtual Account
DELETE /{version}/transfer-va/delete-va
This service is used to delete the VA number permanently.
Service code: 31
Current version: v1.0
* is required
URL Path
Sandbox: https://debit-sandbox.faspay.co.id/v1.0/transfer-va/delete-va
Request Body
Delete VA Response Parameter
Delete VA-Request Sample Delete VA-Response Sample
Copy {
"partnerServiceId" : "088899" ,
"customerNo" : "12345678901234567890" ,
"virtualAccountNo" : "08889912345678901234567890" ,
"additionalInfo" : {
"reason" : "Order Canceled"
}
}
Copy {
"responseCode" : "2003100" ,
"responseMessage" : "Success" ,
"virtualAccountData" : {
"partnerServiceId" : "088899" ,
"customerNo" : "12345678901234567890" ,
"virtualAccountNo" : "08889912345678901234567890" ,
"additionalInfo" : {
"billNo" : "98765123456789" ,
"trxStatusCode" : "3" ,
"trxStatusDesc" : "Order Canceled"
}
}
}
Payment Notification
Payment notification from Faspay to the merchant backend will also trigger an event of transaction status updating to ensure the merchant is securely informed. Please provide the URL and make sure it's already registered on Faspay system.
The detailed API reference can be found here
Integration Requirement
Response Code
Response Code List
