SNAP Disbursement

**Please take note that this SNAP-documentation is beta version.
API Services
Header
Field
Attribute
Type
Description
Content-Type
Mandatory
String
application/json
X-TIMESTAMP
Mandatory
String
Client's current local time in yyyy-MM-ddTHH:mm:ssTZD format
X-SIGNATURE
Mandatory
String
Represents signature of a request.
Asymetric-Signature :
 
SHA256withRSA (Private_Key, stringToSign)
 
dengan formula
stringToSign =
 
HTTPMethod +”:“+ EndpointUrl +":“+ Lowercase(HexEncode(SHA-256(minify(RequestBody)))) + ":“ + TimeStamp
ORIGIN
Optional
String
Origin Domain www.yourdomain.com
X-PARTNER-ID
Mandatory
String (5)
Unique ID for a partner
X-EXTERNAL- ID
Mandatory
String (36)
Numeric String. Reference number that should be unique in the same day
CHANNEL-ID
Mandatory
String (5)
Channel identifier using Faspay’s API Service (88001)
Header Response
Field
Attribute
Type
Description
Content-Type
Mandatory
String
application/json
X-TIMESTAMP
Mandatory
String
Client's current local time in yyyy-MM-ddTHH:mm:ssTZD format
Header Sample Request
Header Sample 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
Content-type: application/json
X-TIMESTAMP: 2020-12-21T10:30:34+07:00
Account Inquiry
post
/{version}
/account-inquiry-external
Account Inquiry
Response Account Inquiry
Parameter
Data Type
M/O/C
Description
responseCode
String (7)
Mandatory
Response code
responseMessage
String (150)
Mandatory
Response description
referenceNo
String (64)
Mandatory
Transaction identifier on faspay’s system. Must be filled upon successful transaction
partnerReferenceNo
String (64)
Mandatory
Transaction identifier on merchant’s system
beneficiaryAccountName
String (100)
Mandatory
Beneficiary Account Name
beneficiaryAccountNo
String (20)
Mandatory
Beneficiary Account Number
beneficiaryBankCode
String (8)
Mandatory
Beneficiary Bank Code
beneficiaryBankName
String (50)
Mandatory
Beneficiary Bank Name
currency
String (3)
Optional
Currency Type, default : IDR
additionalInfo
Object
Mandatory
Additional information
    status
String (1)
Mandatory
List registration status:
1 = On Process
6 = Already Registered
   message
String
Mandatory
Message description
Account Inquiry-Sample Request
Account Inquiry - Sample Response
{
   "beneficiaryBankCode":"002",
   "beneficiaryAccountNo":"888801000157508",
   "partnerReferenceNo":"2020102900000000000001",
   "additionalInfo":{
       "sourceAccount":"9920000082"
}
}
{
   "responseCode":"2001600",
   "responseMessage":"Request has been processed successfully",
   "referenceNo":"2020102977770000000009",
   "partnerReferenceNo":"2020102900000000000001",
   "beneficiaryAccountName":"Yories Yolanda",
   "beneficiaryAccountNo":"888801000157508",
   "beneficiaryBankCode":"002",
   "beneficiaryBankName":"Bank BRI",
   "currency":"IDR",
   "additionalInfo":{
          "status":"1",
          "message":"On Process" 
}
}
Trigger Transfer – InterBank Transfer
post
/{version}
/inter-bank
Trigger Transfer - Interbank Transfer
Response - Trigger Transfer Inter Bank
Parameter
Data Type
M/O/C
Description
responseCode
String (7)
Mandatory
Response code
responseMessage
String (150)
Mandatory
Response description
referenceNo
String (16)
Mandatory
Transaction identifier on faspay’s system. Must be filled upon successful transaction
partnerReferenceNo
String (64)
Mandatory
Transaction identifier on merchant’s system
amount
Object
Mandatory
 
      value
String (ISO4217) (12,2)
Mandatory
Net amount of the transaction.
If it’s IDR then value includes 2 decimal digits.
e.g. IDR 10.000,- will be placed with 10000.00
     currency
String (3)
Mandatory
Currency
beneficiaryAccountNo
String (19)
Mandatory
Beneficiary Account Number
beneficiaryBankCode
String (3)
Mandatory
Beneficiary Bank Code
sourceAccountNo
String (10)
Mandatory
Source Account Number
additionalInfo
Object
Mandatory
Additional information
   beneficiaryAccountName
String (100)
Mandatory
Beneficiary Account Name
     beneficiaryBankName
String (50)
Mandatory
Beneficiary bank name
     instructDate
DateTime (50)
Mandatory
Response of instruct date has been sent
     transactionDescription
String (15)
Mandatory
Description, If the user input is more than 15 characters, it will be cut into 15 characters.
     callbackUrl
String (255)
Mandatory
URL for callback / notification, used to notify the merchant.
     status
String
Mandatory
List of status transaction:
1 = On Process,
2 = Success,
4 = Failed,
5 = Reverse
     message
String
Mandatory
Message transaction
Trigger Transfer Inter Bank - Sample Request
Trigger Transfer Inter Bank - Sample Response
{
   "partnerReferenceNo":"2020102900000000000001",
   "amount":{
      "value":"12345678.00",
      "currency":"IDR"
   },
   "beneficiaryAccountName":"Yories Yolanda",
   "beneficiaryAccountNo":"888801000003301",
   "beneficiaryBankCode":"002",
   "beneficiaryEmail":"[email protected]",
   "sourceAccountNo":"888801000157508",
   "transactionDate":"2019-07-03T12:08:56-07:00",
   "additionalInfo":{
       "instructDate":"",
       "transactionDescription":"Transfer",
       "callbackUrl":"https://dev2.faspay.co.id/account/api/callback"
   }
}
{
   "responseCode":"2001800",
   "responseMessage":"Request has been processed successfully",
   "referenceNo":"2020102977770000000009",
   "partnerReferenceNo":"2020102900000000000001",
   "amount":{
      "value":"12345678.00",
      "currency":"IDR"
   },
   "beneficiaryAccountNo":"888801000003301",
   "beneficiaryBankCode":"002",
   "sourceAccountNo":"888801000157508",
   "additionalInfo":{
      "beneficiaryAccountName":"Yories Yolanda",
      "beneficiaryBankName":"BRI",
      "instructDate":"2019-07-03T12:08:56-07:00",
      "transactionDescription":"Transfer",
      "callbackUrl":"https://dev2.faspay.co.id/account/api/callback",
      "status":"1",
      "message":"On Process"
   }
}
Transfer Status Inquiry Bank
post
/{version}
/transfer/status
Transfer Status Inquiry Bank 
Response Parameter – Transfer Status Inquiry Bank
Parameter
Data Type
M/O/C
Description
responseCode
String (7)
Mandatory
Response code
responseMessage
String (150)
Mandatory
Response description
originalReferenceNo
String (16)
Conditional
Original transaction identifier on merchant’s system. Must be filled upon successful transaction
originalPartnerReferenceNo
String (64)
Mandatory
Original transaction identifier on service consumer system
serviceCode
String (2)
Mandatory
Use service code 18 to inquiry interbank transfer status
transactionDate
Datetime (25)
Optional
transaction date : ISO 8601 FORMAT: ‘yyyy-MM-dd’T’HH:mm:ssTZD’
amount
Object
Optional
​
     value
String (ISO4217) (12,2)
Mandatory
Net amount of the transaction. If it's IDR then value includes 2 decimal digits. e.g. IDR 10.000,- will be placed with 10000.00
     currency
String (3)
Mandatory
Currency
beneficiaryAccountNo
String (34)
Mandatory
Beneficiary Account
beneficiaryBankCode
String (3)
Optional
Beneficiary Bank Code
referenceNumber
String (30)
Optional
Reference Number from system
sourceAccountNo
String (10)
Mandatory
Source Account
latestTransactionStatus
String (2)
Mandatory
00 - Success 
01 - Initiated 
02 - Paying 
03 - Pending 
04 - Refunded 
05 - Canceled 
06 - Failed 
07 - Not found
transactionStatusDesc
String (50)
Mandatory
Description status transaction
additionalInfo
Object
Mandatory
Additional information
      beneficiaryAccountName
String (128)
Mandatory
Account number of VA receiver
      beneficiaryBankName
String (128)
Mandatory
Beneficiary bank name
      transactionDescription
String (15)
Mandatory
Transaction description
      callbackUrl
String (255)
Mandatory
URL for callback / notification, used if the merchant wants the system to notify the merchant.
      transactionStatusDate
Datetime (25)
Mandatory
Transaction of success date ISO 8601 FORMAT: ‘yyyy-MM-dd’T’HH:mm:ssTZD
Request - Transfer Status Inquiry Bank
Response - Transfer Status Inquiry Bank
{
   "originalPartnerReferenceNo":"2020102900000000000001",
   "originalReferenceNo":"2020102977770000000009",
   "serviceCode":"18"
}
​
{
   "responseCode":"2003600",
   "responseMessage":"Request has been processed successfully",
   "originalReferenceNo":"2020102977770000000009",
   "originalPartnerReferenceNo":"2020102900000000000001",
   "serviceCode":"18",
   "transactionDate":"2019-07-03T12:08:56-07:00",
   "amount":{
      "value":"12345678.00",
      "currency":"IDR"
   },
   "beneficiaryAccountNo":"888801000003301",
   "beneficiaryBankCode":"002",
   "referenceNumber":"10052019",
   "sourceAccountNo":"888801000157508",
   "latestTransactionStatus":"00",
   "transactionStatusDesc":"success",
   "additionalInfo":{
      "beneficiaryAccountName":"Yories Yolanda",
      "beneficiaryBankName":"Bank BRI",
      "transactionDescription":"Transfer",
      "callbackUrl":" https://dev2.faspay.co.id/account/api/callback ",
      "transactionStatusDate":"2019-07-03T12:08:56-07:00"
   }
}
Inquiry Balance
post
/{version}
/balance-inquiry
Inquiry Balance
Response Parameter – Inquiry Balance
Parameter
Data Type
M/O/C
Description
responseCode
String (7)
Mandatory
Response code
responseMessage
String (150)
Mandatory
Response description
accountNo
String 
Mandatory
Merchant’s sendme account number
accountInfos
Array
Mandatory
​
      balanceType
String (70)
Optional 
Account type name : “CASH”, “DEPOSIT”, “DEPOSIT BALANCE SETTLEMENT”
     amount
Object 
Optional
Net amount of the transaction.
         value
String (12,2)
Mandatory
If it's IDR then value includes 2 decimal digits. e.g. IDR 10.000,- will be placed with 10000.00
         currency
String (3)
Mandatory
Currency (IDR)
     availableBalance
Object
Mandatory
Account balance that can be used for financial transaction
        value
String (12,2)
Mandatory
If it's IDR then value includes 2 decimal digits.
e.g. IDR 10.000,- will be placed with 10000.00
       currency
String (3)
Mandatory
Currency (IDR)
     status
String (1)
Mandatory
Account Status 
1 = Active Account 
2 = Closed Account 
4 = New Account 
6 = Restricted Account 
7 = Frozen Account 
9 = Dormant Account
Request - Inquiry Balance Sample Code
Response - Inquiry Balance Sample Code
{
   "accountNo":"7382382957893840"
}
{
   "responseCode":"2001100",
   "responseMessage":"Request has been processed successfully",
   "accountNo":"115471119",
   "accountInfo":[
      {
         "balanceType":"CASH",
         "amount":{
            "value":"200000.00",
            "currency":"IDR"
         },
         "availableBalance":{
            "value":"130000.00",
            "currency":"IDR"
         },
         "status":"0001"
      },
      {
         "balanceType":"DEPOSIT",
         "amount":{
            "value":"200000.00",
            "currency":"IDR"
         },
         "availableBalance":{
            "value":"130000.00",
            "currency":"IDR"
         },
         "status":"0001"
      }
   ],
}
​
History List
post
.../{version}/transaction-history-list
/transaction-history-list
History List
Notes: 
Maximum time span = 1 month
Oldest transaction history = 1 year
Response - History List
Parameter
Data Type
M/O/C
Description
responseCode
String (7)
Mandatory
Response code
responseMessage
String (150)
Mandatory
Response description
detailData
Array
​
​
   dateTime
ISODateTimeISO-860 (25)
Mandatory
​
   amount
Object
Mandatory
​
      value
Object
Mandatory
Net amount of the transaction. If it's IDR then value includes 2 decimal digits. e.g. IDR 10.000,- will be placed with 10000.00
      currency
String (ISO4217) (3)
Mandatory
Currency
   remark
String (256)
Mandatory
Transaction remark.
   sourceOfFunds
List (N/A)
Mandatory
Source of funds used for this transaction.
      source
String (32)
Mandatory
Source of fund. = Available Balance
   status
String (32)
Mandatory
Transaction status. INIT, SUCCESS, CLOSED, CANCELLED
   type
String (32)
Mandatory
Transaction type. PAYMENT, REFUND, TOP_UP, SEND_MONEY, RECEIVE_MONEY
   additionalInfo
Object
Optional
Additional information from detailData
      debitCredit
String (1)
Mandatory
Transaction type : 
D (Debit) 
K (Kredit)
additionalInfo
Object
Mandatory
Additional information
   accountNo
String (10)
Mandatory
Merchant’s account number
   fromDateTime
ISODateTimeISO-8601 (25)
Mandatory
Start date of inquiry mutation
   toDateTime
ISODateTimeISO-8601 (25)
Mandatory
End date of inquiry mutation
   message
String (50)
Mandatory
Message description
Request - History List Sample Code
Response - History List Sample Code
{
   "fromDateTime":"2019-07-03T12:08:56-07:00",
   "toDateTime":"2019-07-03T12:08:56-07:00",
   "additionalInfo":{
         "accountNo":"9920015307"
   }
}
{
   "responseCode":"2001200",
   "responseMessage":"Request has been processed successfully",
   "detailData":[
      {
         "dateTime":"2019-07-03T12:08:56-07:00",
         "amount":{
               "value":"12345678.00",
               "currency":"IDR"
         },
         "remark":"Payment to Warung Ikan Bakar",
         "sourceOfFunds":[
            {
               "source":"BALANCE"
               }
            }
         ],
         "status":"SUCCESS",
         "type":"PAYMENT",
         "additionalInfo":{
               "debitCredit":"D"
         }
      }
   ],
   "additionalInfo":{
      "accountNo":"9920015307",
      "fromDateTime":"2019-07-03T12:08:56-07:00",
      "toDateTime":"2019-07-03T12:08:56-07:00",
      "message":"Success"
   }
}
Customer Top Up
post
/{version}/emoney
/topup
Customer Top Up
Response - Customer Top Up
Parameter
Data Type
M/O/C
Description
responseCode
String (7)
Mandatory
Response code
responseMessage
String (150)
Mandatory
Response description
referenceNo
String (16)
Mandatory
Transaction identifier on Faspay’s system. Must be filled upon successful transaction
partnerReferenceNo
String (64)
Mandatory
Transaction identifier on Merchant's system
customerNumber
String (64)
Mandatory
Beneficiary account number
amount
Object
Mandatory
​
      value
String (ISO4217) (12,2)
Mandatory
Net amount of the transaction. If it's IDR then value includes 2 decimal digits. e.g. IDR 10.000,- will be placed with 10000.00
       currency
String (3)
Mandatory
Currency
additionalInfo
Object
Mandatory
Additional information
      sourceAccount
String (10)
Mandatory
Source account number
      platformCode
String (3)
Mandatory
Beneficiary bank code: 
ovo = ovo 
gpy = GoPay 
dna = DANA 
lkj = LinkAja
      beneficiaryEmail
String (128)
Optional
Beneficiary email
      transactionDate
ISODateTime ISO-8601 (25)
Mandatory
Transaction date 
ISO-8601 
​
FORMAT: ‘yyyy-MM-dd’T’HH:mm:ssTZD’
     instructDate
ISODateTime ISO-8601 (25)
Mandatory
Transfer instruction date from request
     transactionDescription
String (255)
Mandatory
Transaction notes
     transactionReference
String (64)
Mandatory
Reference of transaction number on system disbursement
     callbackUrl
String (255)
Mandatory
URL for callback / notification, used if the merchant wants the system to send notifications to the merchant
     status
String (1)
Mandatory
List Status Transaction : 
1 = On Process, 
2 = Success, 
4 = Failed, 
5 = Reverse
     message
String (50)
Mandatory
Message Description
Request - Customer Top-Up Sample Code
Response - Customer Top-Up Sample Code
{
   "partnerReferenceNo":"2020102900000000000001",
   "customerNumber":"6281773628883",
   "amount":{
      "value":"12345678.00",
      "currency":"IDR"
   },
   "transactionDate":"2020-12-21T17:01:11+07:00",
   "additionalInfo":{
      "sourceAccount":"9920011089",
      "platformCode":"ovo",
      "instructDate":"",
      "beneficiaryEmail":"[email protected]"
Field	Attribute	Type	Description
Content-Type	Mandatory	String	application/json
X-TIMESTAMP	Mandatory	String	Client's current local time in yyyy-MM-ddTHH:mm:ssTZD format
X-SIGNATURE	Mandatory	String	Represents signature of a request. Asymetric-Signature : SHA256withRSA (Private_Key, stringToSign) dengan formula stringToSign = HTTPMethod +”:“+ EndpointUrl +":“+ Lowercase(HexEncode(SHA-256(minify(RequestBody)))) + ":“ + TimeStamp
ORIGIN	Optional	String	Origin Domain www.yourdomain.com
X-PARTNER-ID	Mandatory	String (5)	Unique ID for a partner
X-EXTERNAL- ID	Mandatory	String (36)	Numeric String. Reference number that should be unique in the same day
CHANNEL-ID	Mandatory	String (5)	Channel identifier using Faspay’s API Service (88001)
Parameter	Data Type	M/O/C	Description
responseCode	String (7)	Mandatory	Response code
responseMessage	String (150)	Mandatory	Response description
referenceNo	String (64)	Mandatory	Transaction identifier on faspay’s system. Must be filled upon successful transaction
partnerReferenceNo	String (64)	Mandatory	Transaction identifier on merchant’s system
beneficiaryAccountName	String (100)	Mandatory	Beneficiary Account Name
beneficiaryAccountNo	String (20)	Mandatory	Beneficiary Account Number
beneficiaryBankCode	String (8)	Mandatory	Beneficiary Bank Code
beneficiaryBankName	String (50)	Mandatory	Beneficiary Bank Name
currency	String (3)	Optional	Currency Type, default : IDR
additionalInfo	Object	Mandatory	Additional information
status	String (1)	Mandatory	List registration status: 1 = On Process 6 = Already Registered
message	String	Mandatory	Message description