SNAP Virtual Account

API Services

The header for transaction request

Header Response

Content-type: application/json 
X-TIMESTAMP: 2020-12-17T10:55:00+07:00 
X-SIGNATURE: 85be817c55b2c135157c7e89f52499bf0c25ad6eeebe04a986e8c862561b19a5 
ORIGIN: www.hostname.com 
X-PARTNER-ID: 82150 
X-EXTERNAL-ID: 41807553358950093184162180797837 
CHANNEL-ID: 88001

API Services

Create Virtual Account (VA)

POST /{version}/transfer-va/create-va

The API Virtual Account service is used to create a VA number for transactions.

Service Code: 27

Notes: - *is required

- Current version: v1.0

URL Path

Sandbox: https://debit-sandbox.faspay.co.id/v1.0/transfer-va/create-va Production: https://web.faspay.co.id/v1.0/transfer-va/create-va

Request Body

This API Service is available for this channel code:
  • 402 -> Permata VA (Dynamic)

  • 408 -> Maybank VA (Dynamic)

  • 702 -> BCA VA (Dynamic)

  • 706 -> Indomaret Payment point (Dynamic)

  • 707 -> Alfagroup (Dynamic)

  • 708 -> Danamon VA (Dynamic)

  • 718 -> BNC VA (Static & Dynamic)

  • 800 -> BRI VA (Dynamic)

  • 801 -> BNI VA (Static & Dynamic)

  • 802 -> Mandiri VA (Dynamic)

  • 818 -> Sinarmas VA (Dynamic)

  • 825 -> CIMB VA (Dynamic)

  • 837 -> BTN VA (Static & Dynamic)

Create VA Response Parameter

{
 "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"
 }
}

Inquiry

POST /{version}/transfer-va/inquiry

The API Virtual Account Inquiry is used to forward user requests to inquire 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

{
    // Response
}
This API service is available for channel code:
  • 402 -> Permata VA (Static)

  • 408 -> Maybank VA (Static)

  • 702 -> BCA VA (Static)

  • 706 -> Indomaret Payment point (Static)

  • 707 -> Alfagroup (Static)

  • 708 -> Danamon VA (Static)

  • 800 -> BRI VA (Static)

  • 802 -> Mandiri VA (Static)

  • 818 -> Sinarmas VA (Static)

  • 825 -> CIMB VA (Static)

Inquiry Response Parameter

{
   "partnerServiceId":"  88899",
   "customerNo":"12345678901234567890",
   "virtualAccountNo":"  08889912345678901234567890",
   "inquiryRequestId":"abcdef-123456-abcdef"
}

Payment

POST /{version}/transfer-va/payment

This service is used to notify payment confirmation for specific VA which 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

{
    // Response
}
This API service is available for channel code:
  • 402 -> Permata VA (Static)

  • 408 -> Maybank VA (Static)

  • 702 -> BCA VA (Static)

  • 706 -> Indomaret Payment point (Static)

  • 707 -> Alfagroup (Static)

  • 708 -> Danamon VA (Static)

  • 800 -> BRI VA (Static)

  • 802 -> Mandiri VA (Static)

  • 818 -> Sinarmas VA (Static)

  • 825 -> CIMB VA (Static)

Payment Response Parameter

{
   "partnerServiceId":"  088899",
   "customerNo":"12345678901234567890",
   "virtualAccountNo":"  08889912345678901234567890",
   "paymentRequestId":"abcdef-123456-abcdef",
   "paidAmount":{
      "value":"12345678.00",
      "currency":"IDR"
   },
   "trxDateTime":"20201231T235959Z"
   "referenceNo":"123456789012345"
}

Inquiry Status

POST /{version}/transfer-va/status

This service is used by merchants to check the status of transfers made.

Service Code: 26

Current version: v1.0

URL Path

Sandbox: https://debit-sandbox.faspay.co.id/v1.0/transfer-va/status Production: https://web.faspay.co.id/v1.0/transfer-va/status

Request Body

{
    // Response
}

Inquiry Status Response Parameter

Status Code List

{
 "partnerServiceId":"088899",
 "customerNo":12345678901234567890,
 "virtualAccountNo":"08889912345678901234567890",
 "inquiryRequestId":"abcdef-123456-abcdef",
 "additionalInfo":{
      "channelCode":"402",
      "trxId":"9876540000001115"
 }
}

Delete Virtual Account

DELETE /{version}/transfer-va/delete-va

This service is used to delete the VA number permanently.

Service Code: 31

Notes: - * is required

- Current version: v1.0

URL Path

Sandbox: https://debit-sandbox.faspay.co.id/v1.0/transfer-va/delete-va Production: https://web.faspay.co.id/v1.0/transfer-va/delete-va

Request Body

{
    // Response
}

Delete VA Response Parameter

{
   "partnerServiceId":"088899",
   "customerNo":"12345678901234567890",
   "virtualAccountNo":"08889912345678901234567890",
   "additionalInfo":{
       "reason":"Order Canceled"
   }
}

Payment Notification

Payment notification from Faspay to merchant backend will also be triggered an event of transaction status getting updated, to ensure 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

Last updated