SNAP Disbursement
API Services
Header
Content-Type
Mandatory
String
application/json
X-TIMESTAMP
Mandatory
String
Client's current local time in yyyy-MM-ddTHH:mm:ssTZD format
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
Content-Type
Mandatory
String
application/json
X-TIMESTAMP
Mandatory
String
Client's current local time in yyyy-MM-ddTHH:mm:ssTZD format
Account Inquiry
POST
/{version}/account-inquiry-external
The Account Inquiry API is used to obtain the recipient's account information and to minimize the possibility of incorrect transfer destinations.
Service code: 16
Current version: v1.0 * is required
URL Path
Sandbox:
https://sendme-sandbox.faspay.co.id/account/v1.0/account-inquiry-external
Request Body
beneficiaryBankCode*
String (8)
Beneficiary Bank Code
beneficiaryAccountNo*
String (34)
Beneficiary Account Number
partnerReferenceNo
String (64)
Transaction identifier on partner’s system
additionalInfo*
Object
Additional information
sourceAccount*
String (10)
Source account number (Sendme virtual account number)
Response
responseCode*
String (7)
Response code
responseMessage*
String (150)
Response description
referenceNo*
String (64)
Transaction identifier on faspay’s system. Must be filled upon successful transaction
partnerReferenceNo*
String (64)
Transaction identifier on partner's system
beneficiaryAccountName*
String (100)
Beneficiary Account Name
beneficiaryAccountNo*
String (20)
Beneficiary Account Number
beneficiaryBankCode*
String (8)
Beneficiary Bank Code
beneficiaryBankName*
String (50)
Beneficiary Bank Name
currency
String (3)
Currency Type, default : IDR
additionalInfo*
Object
Additional information
status*
String (1)
1 = Success
message*
String (50)
Message description
Notes:
When doing a trigger transfer, always make at least one account inquiry you want to transfer first.
Trigger Transfer – InterBank Transfer
POST
/account/{version}/transfer-interbank
This service is used for transfers from the partner's account to the destination account that has been previously registered.
Service code: 18 Current version: v1.0 * is required
URL Path
Sandbox:
https://sendme-sandbox.faspay.co.id/account/v1.0/transfer-interbank
Request Body
partnerReferenceNo*
String (64)
Transaction identifier on partner’s system
amount*
Object
value*
String (12,2)
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
Currency
beneficiaryAccountName*
String (100)
Beneficiary Account Name
beneficiaryAccountNo*
String (34)
Beneficiary Account
beneficiaryBankCode*
String (3)
Beneficiary Bank Code
beneficiaryEmail
String (50)
Beneficiary Email
sourceAccountNo*
String (10)
Source Account Number
(Sendme account number)
transactionDate*
Date (25)
transaction date : ISO 8601
FORMAT: ‘yyyy-MM-dd’T’HH:mm:ssTZD’
additionalInfo*
Object
Additional information
instructDate
Datetime
Instruct date is date for transaction
ISO 8601
FORMAT: ‘yyyy-MM-dd’T’HH:mm:ssTZD’
if Null/Empty, transaction will be processed immediately
If filled then the transaction will be sent as date filled.
transactionDescription
String (15)
Description, If the user input is more than 15 characters, it will be cut into 15 characters.
callbackUrl*
String (255)
URL for callback / notification, used to notify the partner.
Response
responseCode*
String (7)
Response code
responseMessage*
String (150)
Response description
referenceNo*
String (16)
Transaction identifier on faspay’s system. Must be filled upon successful transaction
partnerReferenceNo*
String (64)
Transaction identifier on partner’s system
amount*
Object
value*
String (ISO4217) (12,2)
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)
Currency
beneficiaryAccountNo*
String (19)
Beneficiary Account Number
beneficiaryBankCode*
String (3)
Beneficiary Bank Code
sourceAccountNo*
String (10)
Source Account Number
additionalInfo*
Object
Additional information
beneficiaryAccountName*
String (100)
Beneficiary Account Name
beneficiaryBankName*
String (50)
Beneficiary bank name
instructDate*
DateTime (50)
Response of instruct date has been sent
transactionDescription*
String (15)
Description, If the user input is more than 15 characters, it will be cut into 15 characters.
callbackUrl*
String (255)
URL for callback / notification, used to notify the partner.
latestTransactionStatus*
String (2)
00 - Success
01 - Initiated
02 - Paying
03 - Pending
04 - Refunded
05 - Canceled
06 - Failed
07 - Not found
transactionStatusDesc*
String (50)
Description status transaction
Transfer Status Inquiry Bank
POST
/account/{version}/transfer/status
Partners use the Bank's Transfer Status Inquiry API to check the status of transfers made.
Service code: 36
Note:*
is required
- Current Version: v1.0
URL Path
Sandbox:
https://sendme-sandbox.faspay.co.id/account/v1.0/transfer/status
Request Body
originalPartnerReferenceNo*
String (64)
Original transaction identifier on partner’s system
originalReferenceNo
String (16)
Original transaction identifier on Faspay’s system
serviceCode*
String (2)
Use service code 18 to inquiry interbank transfer status.
Response Parameter – Transfer Status Inquiry Bank
responseCode
String (7)
Mandatory
Response code
responseMessage
String (150)
Mandatory
Response description
originalReferenceNo
String (16)
Conditional
Original transaction identifier on partner’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 partner wants the system to notify the partner.
transactionStatusDate
Datetime (25)
Mandatory
Transaction of success date ISO 8601 FORMAT: ‘yyyy-MM-dd’T’HH:mm:ssTZD
Inquiry Balance
POST
/account/{version}/balance-inquiry
Inquiry Balance API is used to check the balance of user accounts registered with Faspay SendMe.
Service Code: 11
Notes: *
is required
- Current Version: v1.0
URL Path
Sandbox:
https://sendme-sandbox.faspay.co.id/account/v1.0/balance-inquiry
Request Body
accountNo*
String (10)
Partner’s Sendme Account number
Response Parameter – Inquiry Balance
responseCode
String (7)
Mandatory
Response code
responseMessage
String (150)
Mandatory
Response description
accountNo
String
Mandatory
Partner’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 (4)
Mandatory
Account Status 1 = Active Account 2 = Closed Account 4 = New Account 6 = Restricted Account 7 = Frozen Account 9 = Dormant Account
History List
POST
account/{version}/transaction-history-list
API History List is used by users/partners to check transaction logs/account mutations registered in Faspay SendMe.
Service Code: 12
Notes: *
is required
- Current Version: v1.0
URL Path
Sandbox:
https://sendme-sandbox.faspay.co.id/account/v1.0/transaction-history-list
Request Body
fromDateTime*
ISODateTimeISO-8601 (25)
Starting time range
toDateTime*
ISODateTimeISO-8601 (25)
Ending time range.
additionalInfo*
Object
Additional information
accountNo*
String (10)
Partner’s sendme account number
Notes:
Maximum time span = 1 month
Oldest transaction history = 1 year
Response - History List
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
latestTransactionStatus
String (2)
Mandatory
00 - Success
01 - Initiated
02 - Paying
03 - Pending
04 - Refunded
05 - Canceled
06 - Failed
07 - Not found
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
Partner’s account number
fromDateTime
ISODateTimeISO-8601 (25)
Mandatory
Start date of inquiry mutation
toDateTime
ISODateTimeISO-8601 (25)
Mandatory
End date of inquiry mutation
transactionStatusDesc
String (50)
Mandatory
Description status transaction
Customer Top Up
Flow Customer Top Up
POST
/account/{version}/emoney/topup
The Customer Top-Up API is used by users/partners to transfer funds to e-wallets.
Service Code: 38
Notes: *
is required
- Customer Version: v1.0
URL Path
Sandbox:
https://sendme-sandbox.faspay.co.id/account/v1.0/emoney/topup
Request Body
partnerReferenceNo*
String (64)
Transaction identifier on partner’s system
customerNumber*
String (32)
Beneficiary Account number
amount*
Object
value*
String (ISO4217) (12,2)
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)
Currency
transactionDate
ISODateTime ISO-8601 (25)
Transaction date
ISO-8601
FORMAT: ‘yyyy-MM-dd’T’HH:mm:ssTZD’
additionalInfo*
Object
Additional information
sourceAccount*
String (10)
Partner’s source account
platformCode*
String (3)
Beneficiary bank code:
ovo = ovo
gpy = GoPay
dna = DANA
lkj = LinkAja
instructDate
ISODateTimeISO-8601 (25)
Instruct date is a date for the transaction
ISO 8601
FORMAT: ‘yyyy-MM-dd’T’HH:mm:ssTZD’ if Null transaction will be processed immediately
If filled then the transaction will be sent as date filled.
beneficiaryEmail
String (128)
Beneficiary email
transactionDescription
String (15)
Transaction description
callbackUrl*
String (255)
URL for callback / notification, used if the partner wants the system to send notifications to the partner
Response - Customer Top Up
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 Partner'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 partner wants the system to send notifications to the partner
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
Customer Top-Up - Inquiry Status
POST
/{version}/emoney/topup-status
This API is used by partners to check the status of top-up.
Service Code: 39
Note: *
is required
- Current Version: v1.0
URL Path Sandbox:
https://sendme-sandbox.faspay.co.id/account/v1.0/emoney/topup-status
Request Body
originalPartnerReferenceNo*
String (64)
Transaction identifier/reference generated by partner.
originalReferenceNo
String (16)
Transaction identifier/reference generated by Faspay.
serviceCode*
String (2)
Use service code 38 to inquiry top up status
Response Customer Top Up - Inquiry Status
responseCode
String (7)
Mandatory
Response code
responseMessage
String (150)
Mandatory
Response description
originalPartnerReferenceNo
String (64)
Mandatory
Transaction identifier/reference generated by partner
originalReferenceNo
String (16)
Mandatory
Transaction identifier/reference generated by Faspay.
serviceCode
String (2)
Mandatory
To identify which transaction that needs to be checked.
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
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
sourceAccount
String (10)
Mandatory
Partner’s source account
transactionDate
ISODateTime ISO-8601 (25)
Mandatory
Transaction date : ISO 8601
FORMAT: ‘yyyy-MM-dd’T’HH:mm:ssTZD’
platformCode
String (3)
Mandatory
Beneficiary Platform code
platformName
String (50)
Mandatory
Beneficiary platform name
customerNumber
String (64)
Mandatory
Beneficiary Account Number
customerName
String (255)
Mandatory
Customer account name
transactionDescription
String (255)
Mandatory
Description of transaction
callbackUrl
String (255)
Mandatory
URL for callback/notification, used if the partner wants the system to notify the partner.
transactionStatusDate
ISODateTime ISO-8601 (25)
Mandatory
Transaction of success date : ISO 8601 FORMAT: ‘yyyy-MM-dd’T’HH:mm:ssTZD’
Bill Payment
This API is used to utilities Bill Payment transactions Services in SNAP Disbursement API.
Flow Bill Payment
This are the flow process Bill Payment transactions in SNAP Disbursement API.
Inquiry Bill Payment to VA from Intrabank
This API is used to inquiry the Bill Payment transaction.
URL Path
.../{version}/transfer-va/inquiry-intrabank
Method
POST
Channel Code
32
Request Parameter – Inquiry Bill Payment to VA Intrabank
The parameter that must be provide by the partner system to be accessed by the Faspay system are as follows:
partnerReferenceNo
O
String
64
Unique identifier for this Payment. Generated by Partner
partnerServiceId
M
String
8
Company code, 8 digit left padding space
customerNo
M
String
20
Unique customer number (up to 20 digits)
virtualAccountNo
M
String
28
Whole virtual account number, partnerServiceId + customerNo
additionalInfo
billerCode
M
String
3
Code of the biller, can be filled with bank code
sourceAccount
M
String
20
Source account number
Response Parameter – Inquiry Bill Payment to VA Intrabank
The parameter that must be provide by the Partner system to be accessed by the Faspay system are as follows:
responseCode
M
String
7
Response code
responseMessage
M
String
150
Response description
virtualAccountData
partnerReferenceNo
M
String
64
Transaction identifier on Partner’s system
partnerServiceId
M
String
8
Company code, 8 digit left padding space
customerNo
M
String
20
Unique customer number (up to 20 digits)
virtualAccountNo
M
String
28
Whole virtual account number, partnerServiceId + customerNo
virtualAccountName
O
String
50
Virtual account name
totalAmount
O
Object
value
M
String
16,2
Amount of the transaction based on ISO 4217.
If it’s IDR then value includes 2 decimal digits. e.g. IDR 10.000,- will be placed with 10000.00
currency
O
String
3
Currency of transaction based on ISO 4217
virtualAccountTrxType
O
String
1
Types of virtual account
Type:
O = Open Payment
C = Closed Payment
additionalInfo
M
Object
billerCode
M
String
3
Code of the biller, can be filled with bank code
sourceAccount
M
String
20
Source account number
status
M
String
1
List registration
status:
1 = On Process
6 = Already Registered
message
M
String
Message description
Bill Payment to VA from Intrabank
This API is used to Bill Payment transaction.
URL Path
.../{version}/transfer-va/payment-intrabank
Method
POST
Channel Code
32
Request Parameter – Bill Payment to VA from Intrabank
The parameter that must be provide by the partner system to be accessed by the Faspay system are as follows:
partnerReferenceNo
O
String
64
Unique identifier for this Payment. Generated by Partner
partnerServiceId
M
String
8
Company code, 8 digit left padding space
customerNo
M
String
20
Unique customer number (up to 20 digits)
virtualAccountNo
M
String
28
Whole virtual account number, partnerServiceId + customerNo
virtualAccountName
O
String
50
Virtual account name
sourceAccount
M
String
20
Source Account Number
paidAmount
M
Object
value
M
String
16,2
Paid amount for this transaction.
If it’s IDR then value includes 2 decimal digits.
e.g. IDR 10.000,- will be placed with 10000.00
currency
M
String
3
Currency of transaction based on ISO 4217
trxDateTime
M
DateTime
25
Partner’s internal system datetime with timezone, which follows the ISO-8601 standard
additionalInfo
M
Object
billerCode
M
String
3
Code of the biller, can be filled with bank code
instructDate
Instruct date is date for transaction ISO-8601
FORMAT: ‘yyyyMMdd’T’HH:mm:ss TZD’
Notes: Only fill out when the desired transaction wants to be scheduled. If it’s null, then the transaction will be done in real-time.
callbackURL
M
String
255
URL for callback / notification, it will be used for notifying partner.
Response Parameter – Bill Payment to VA from Intrabank
The parameter that must be provide by the partner system to be accessed by the Faspay system are as follows:
responseCode
M
String
7
Response code
responseMessage
M
String
150
Response description
virtualAccountData
M
Object
partnerReferenceNo
M
String
64
Transaction identifier on partner’s system
referenceNo
M
String
64
Transaction identifier on Faspay’s system. Must be filled upon successful transaction
partnerServiceId
M
String
8
Company code, 8 digit left padding space
customerNo
M
String
20
Unique customer number (up to 20 digits)
virtualAccountNo
M
String
28
Whole virtual account number, partnerServiceId + customerNo
virtualAccountName
O
String
50
Virtual account name
sourceAccountNo
M
String
20
Source Account Number
paidAmount
M
Object
value
M
String
16,2
Paid amount for this transaction based on ISO 4217.
If it’s IDR then value includes 2 decimal digits. e.g. IDR 10.000,- will be placed with 10000.00
currency
M
String
3
Currency of transaction based on ISO 4217
trxDateTime
M
DateTime
25
Partner’s internal system datetime with timezone, which follows the ISO-8601 standard
additionalInfo
M
Object
billerCode
M
String
3
Code of the biller, can be filled with bank code
instructDate
M
DateTime
50
Instruct date is date for transaction ISO-8601
FORMAT: ‘yyyyMMdd’T’HH:mm:ss TZD’
Only fill out when the desired transaction wants to be scheduled. If it’s null, then the transaction will be done in real-time.
callbackUrl
M
String
255
URL for callback / notification, it will be used for notifying partner.
status
M
String
-
List of status transaction:
1 = On Process,
2 = Success,
4 = Failed,
5 = Reverse
message
M
String
-
Message transaction
Last updated