SNAP Disbursement

API Services

FieldAttributeTypeDescription

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

FieldAttributeTypeDescription

Content-Type

Mandatory

String

application/json

X-TIMESTAMP

Mandatory

String

Client's current local time in yyyy-MM-ddTHH:mm:ssTZD format

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

Account Inquiry

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

Notes: * is required

- Current Version: v1.0

URL Path

Production:

https://sendme.faspay.co.id/account/v1.0/account-inquiry-external

Sandbox:

https://account-sandbox.faspay.co.id/account/v1.0/account-inquiry-external

Request Body

NameTypeDescription

beneficiaryBankCode*

String (8)

Beneficiary Bank Code

beneficiaryAccountNo*

String (34)

Beneficiary Account Number

partnerReferenceNo

String (64)

Transaction identifier on merchant’s system

additionalInfo*

Object

Additional information

sourceAccount*

String (10)

Source account number (Sendme virtual account number)

{
    // Response
}

Response Account Inquiry

ParameterData TypeM/O/CDescription

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

1 = Success

message

String (50)

Mandatory

Message description

{
   "beneficiaryBankCode":"002",
   "beneficiaryAccountNo":"888801000157508",
   "partnerReferenceNo":"2020102900000000000001",
   "additionalInfo":{
       "sourceAccount":"9920000082"
}
}

Notes:

When doing a trigger transfer, always make sure to make at least one account inquiry that you want to transfer first.

Trigger Transfer – InterBank Transfer

Trigger Transfer - Interbank Transfer

POST /account/{version}/transfer-interbank

This service is used for transfers from the merchant's account to the destination account that has been previously registered.

Service Code: 18

Notes: * is required

- Current Version: v1.0

URL Path

Production:

https://sendme.faspay.co.id/account/v1.0/transfer-interbank

Sandbox:

https://account-sandbox.faspay.co.id/account/v1.0/transfer-interbank

Request Body

NameTypeDescription

partnerReferenceNo*

String (64)

Transaction identifier on merchant’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 merchant.

{
    // Response
}

Response - Trigger Transfer Inter Bank

ParameterData TypeM/O/CDescription

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.

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

{
   "partnerReferenceNo":"2020102900000000000001",
   "amount":{
      "value":"12345678.00",
      "currency":"IDR"
   },
   "beneficiaryAccountName":"Yories Yolanda",
   "beneficiaryAccountNo":"888801000003301",
   "beneficiaryBankCode":"002",
   "beneficiaryEmail":"yories.yolanda@work.bri.co.id",
   "sourceAccountNo":"888801000157508",
   "transactionDate":"2019-07-03T12:08:56-07:00",
   "additionalInfo":{
       "instructDate":"",
       "transactionDescription":"Transfer",
       "callbackUrl":"https://dev2.faspay.co.id/account/api/callback"
   }
}

Transfer Status Inquiry Bank

Transfer Status Inquiry Bank

POST /account/{version}/transfer/status

The Bank's Transfer Status Inquiry API is used by merchants to check the status of transfers made.

Service code: 36

Note:* is required

- Current Version: v1.0

URL Path

Production:

https://sendme.faspay.co.id/account/v1.0/transfer/status

Sandbox:

https://account-sandbox.faspay.co.id/account/v1.0/transfer/status

Request Body

NameTypeDescription

originalPartnerReferenceNo*

String (64)

Original transaction identifier on merchant’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
}

Response Parameter – Transfer Status Inquiry Bank

ParameterData TypeM/O/CDescription

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

{
   "originalPartnerReferenceNo":"2020102900000000000001",
   "originalReferenceNo":"2020102977770000000009",
   "serviceCode":"18"
}

Inquiry Balance

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

Production:

https://sendme.faspay.co.id/account/v1.0/balance-inquiry

Sandbox:

https://account-sandbox.faspay.co.id/account/v1.0/balance-inquiry

Request Body

NameTypeDescription

accountNo*

String (10)

Merchant’s Sendme Account number

{
    // Response
}

Response Parameter – Inquiry Balance

ParameterData TypeM/O/CDescription

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 (4)

Mandatory

Account Status 1 = Active Account 2 = Closed Account 4 = New Account 6 = Restricted Account 7 = Frozen Account 9 = Dormant Account

{
   "accountNo":"7382382957893840"
}

History List

History List

POST account/{version}/transaction-history-list

API History List is used by users/merchants to check transaction logs/account mutations registered in Faspay SendMe.

Service Code: 12

Notes: * is required

- Current Version: v1.0

URL Path

Production:

https://sendme.faspay.co.id/account/v1.0/transaction-history-list

Sandbox:

https://account-sandbox.faspay.co.id/account/v1.0/transaction-history-list

Request Body

NameTypeDescription

fromDateTime*

ISODateTimeISO-8601 (25)

Starting time range

toDateTime*

ISODateTimeISO-8601 (25)

Ending time range.

additionalInfo*

Object

Additional information

accountNo*

String (10)

Merchant’s sendme account number

{
    // Response
}

Notes:

Maximum time span = 1 month

Oldest transaction history = 1 year

Response - History List

ParameterData TypeM/O/CDescription

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

Merchant’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

{
   "fromDateTime":"2019-07-03T12:08:56-07:00",
   "toDateTime":"2019-07-03T12:08:56-07:00",
   "additionalInfo":{
         "accountNo":"9920015307"
   }
}

Customer Top Up

Flow Customer Top Up

Customer Top Up

POST /account/{version}/emoney/topup

The Customer Top-Up API is used by users/merchants to transfer funds to e-wallets.

Service Code: 38

Notes: * is required

- Customer Version: v1.0

URL Path

Production:

https://sendme.faspay.co.id/account/v1.0/emoney/topup

Sandbox:

https://account-sandbox.faspay.co.id/account/v1.0/emoney/topup

Request Body

NameTypeDescription

partnerReferenceNo*

String (64)

Transaction identifier on merchant’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)

Merchant’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 merchant wants the system to send notifications to the merchant

{
    // Response
}

Response - Customer Top Up

ParameterData TypeM/O/CDescription

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

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

{
   "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":"john.doe@faspay.co.id",
      "trxDescription":"Transfer",
      "callbackUrl":""http://account-service/account/api/mail/sendtotele"
   }
}

Customer Top-Up - Inquiry Status

Customer Top Up - Inquiry Status

POST /{version}/emoney/topup-status

This API is used by merchants to check the status of top-up.

Service Code: 39

Note: * is required

- Current Version: v1.0

URL Path Production:

https://sendme.faspay.co.id/account/v1.0/emoney/topup-status

Sandbox:

https://account-sandbox.faspay.co.id/account/v1.0/emoney/topup-status

Request Body

NameTypeDescription

originalPartnerReferenceNo*

String (64)

Transaction identifier/reference generated by merchant.

originalReferenceNo

String (16)

Transaction identifier/reference generated by Faspay.

serviceCode*

String (2)

Use service code 38 to inquiry top up status

{
    // Response
}

Response, Customer Top Up - Inquiry Status

ParameterData TypeM/O/CDescription

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

Merchant’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 merchant wants the system to notify the merchant.

transactionStatusDate

ISODateTime ISO-8601 (25)

Mandatory

Transaction of success date : ISO 8601 FORMAT: ‘yyyy-MM-dd’T’HH:mm:ssTZD’

{
   "originalPartnerReferenceNo":"2021072342358089475892734",
   "originalReferenceNo":"2021072342358089475892091",
   "serviceCode":"38"
}

Last updated