Faspay
  • Homepage
  • Getting Started
    • Faspay Business
      • Debit Transaction
        • Features
          • Static Transaction
            • Virtual Account Static
          • UNIcount
      • Credit Card Transaction
        • Recurring Payment
    • Faspay Billing
      • Introduction
      • Feature
      • How To Use
        • Getting Started
        • Dashboard
        • Recipient
          • List Recipient
          • Recipient Group
          • Recurrence Status
        • Scheduled Status
        • Invoice
        • Report
        • Create Billing System
          • Single Billing
          • Mass Billing
        • Billing Setting
          • Reminder Setting
          • Template Setting
          • Invoice Status
    • Faspay Billing 2.0
      • How to Use
        • Getting Started
        • Billings
          • Billings List
            • Detail Billing
            • Upload Document
          • Scheduled Billing
          • Recurring Billing
          • Static VA Generator
            • Static VA Close Generator
            • Static VA Open Generator
            • Static VA List
            • Payment History
            • Excel File Template
        • Customers
          • Customer List
          • Customer Group
        • Reports
          • Invoice Issued
          • Payment History
          • Summary Outstanding
          • Detail Outstanding
          • Invoice Aging Report
          • Invoice Paid Report
          • Export Report
        • Items
          • Product Catalogs
          • Rooms
          • Product Category
          • UoM (Unit of Measurement)
        • E-Faktur
          • E-Faktur Range Number
            • Generate E-Faktur Number
            • Cancelation E-Faktur Number
          • Export CSV
          • E-Faktur Files
          • Setting Threshold E-Faktur
        • QR Business Profile
          • Create Business Profile
          • Business Profile List
          • Access Business Profile Page
          • Transaction History on Business Profile
            • Lite Sales App
        • Billing Settings
    • Faspay Xpress
      • Faspay Xpress 4.0
        • Setting Language
        • Payment Method
        • Quick Payment Guide
        • Send your Order Details and Payment Instructions
        • Payment Status
        • Payment Receipt
        • Rating Payment
      • Setting Xpress
    • Faspay SendMe
      • Introduction
      • Credentials
      • List Of Service API
      • Authentication
        • Header
        • Authorization
        • Signature
          • Generate signature token
          • Generate signature other service
          • HTTP Method
          • Relative URL
        • Request Body
        • Access Token
      • Cash Out
        • Alfamart Cash Out
        • Indomaret Cash Out
      • E-Wallet
    • SNAP
      • SNAP Direct Debit
      • SNAP QRIS
      • SNAP Virtual Account
      • SNAP Disbursement
  • Merchant Integration
    • API Reference
      • Debit
        • Payment Channel Inquiry
        • Post Data Transaction
        • Redirect Process
        • Inquiry Payment Status
        • Cancel Transaction
        • Payment Notification
        • URL Callback/Return URL
        • Reference
          • Status Response Code
          • Payment Channel Code
        • Bank Transfer Integration Guide
        • Internet Banking integration Guide
        • Retail Payment Integration Guide
        • Online Debit Integration Guide
          • B-secure
          • BRI Direct Debit
        • Online Credit Integration Guide
          • Status Response Code
        • e-Money Integration Guide
          • LinkAja Integration Guide
          • LinkAja QRIS Integration Guide
          • LinkAja AppLink Integration Guide
          • DANA Integration Guide
          • Sakuku Integration Guide
          • OVO Integration Guide
          • ShopeePay Jump App Integration Guide
          • ShopeePay QRIS Integration Guide
          • OVO Tokenize Integration Guide
          • DANA Subs Integration Guide
          • Paydia QRIS Integration Guide
        • Features
          • Static Transaction Integration
            • BNI VA Static Integration
            • BNC VA Static Integration
          • Unicount
        • Postman Collection
      • Credit Card
        • Payment Integration API
        • Additional API Integration
          • Inquiry Payment Status
          • Capture Transaction
          • Transaction Void
          • Refund Transaction
          • Signature Transaction
            • Generate Signature Request
            • Genarete signature response
          • Server CallBack / URL Notification Credit Card
          • API Tokenization
            • Payment Window Integration API
            • Payment Direct API
            • Advance Functionality API Tokenization
              • Inquiry Detail Token
              • Inquiry Delete Token
              • Inquiry Last Token (Dynamic Token Only)
        • Recurring Payment API
          • Message Flow Transaction
            • Post Transaction
            • Update Card
          • JSON Message Format
            • Update Member
            • Inquiry Status
            • Payment Notification
            • Notification CC Expired
          • Status Response Code
        • Response Transaction
          • Response Success
          • Response Failed
          • Response Code Error Transaction
          • User Notification Screen
        • Reference
          • Faspay e-Payment Error Code Listing - CC
          • Transaction Status - CC
          • End User Indicator (EUI)
          • Categories of User Code and User Message - CC
          • ECI
      • Xpress
        • Xpress Version 4🆕
      • Faspay Billing API
        • Create Billing
        • Inquiry Billing
        • Cancel Billing
        • Get List Invoice
        • Callback
      • SendMe
        • Register Account
        • Confirmation Register Account
        • Transfer
        • Inquiry Name
        • Inquiry Balance
        • Mutasi
        • Inquiry Status
        • Notification / Callback
        • Error Code And Response Code
        • APPENDIX
        • Cash Out
          • ATM Permata Cash Out
          • Alfamart Cash Out
          • Indomaret Cash Out
        • E-Wallet (Top Up)
          • Inquiry Name
          • Transfer (Top Up)
      • SNAP
        • Signature SNAP
        • SNAP Virtual Account
        • SNAP Direct Debit
        • SNAP QRIS
        • SNAP Disbursement
          • Response Code
      • Route Payment
        • Post Data Transaction
        • SNAP Generate QRIS
        • SNAP Create Virtual Account
        • SNAP Direct Debit
        • Inquiry Static VA
        • SNAP Inquiry Static VA
        • Response Code
    • E-Commerce Plugin
      • Woocommerce
      • Ecwid
  • SDK Integration
    • SendMe SDK
      • Integration with Java SDK
      • Integrate with PHP SDK
      • Integrate with Python SDK
  • BEFORE LIVE
    • Whitelist IP
    • Account Testing
    • Sample Code
  • AFTER LIVE
  • Merchant page Reference
    • Change Password
    • Dashboard
    • Transactions
      • Debit
      • Credit
      • Settlement
      • Notification
    • Settings Profile
    • Faspay Business
      • Credential Settings
      • Report Settings
        • Daily Report Settings
        • Daily Report
        • Resend Daily Report
      • Developer Settings
      • Route Payment
        • Transaction Report
        • History
    • Faspay SendMe
      • Google Authenticator Pairing
      • Disbursement Account
      • Withdrawal
      • Withdraw History
      • Single Transfer
      • Mass Transfer
        • Upload File
        • Validation
        • Mass Transfer
      • Transaction History
      • Paycheck
      • Top Up
      • Credential Settings
      • Report Settings
        • Daily Report
        • Daily Report Setting
        • Resend Daily Report
Powered by GitBook
On this page
  • API Services
  • Header
  • Account Inquiry
  • Trigger Transfer – InterBank Transfer
  • Transfer Status Inquiry Bank
  • Inquiry Balance
  • History List
  • Customer Top Up
  • Customer Top-Up - Inquiry Status
  • Bill Payment
  1. Merchant Integration
  2. API Reference
  3. SNAP

SNAP Disbursement

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.

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

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

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

Parameter
Data Type
Description

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

Parameter
Data Type
Description

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

{
   "beneficiaryBankCode":"002",
   "beneficiaryAccountNo":"888801000157508",
   "partnerReferenceNo":"2020102900000000000001",
   "additionalInfo":{
       "sourceAccount":"9920000082"
}
}
{
    "responseCode": "2001600",
    "responseMessage": "Request has been processed successfully",
    "referenceNo": "2023082914320300000034",
    "partnerReferenceNo": "",
    "beneficiaryAccountName": "Budi",
    "beneficiaryAccountNo": "60004400184",
    "beneficiaryBankCode": "008",
    "beneficiaryBankName": "BANK MANDIRI",
    "currency": "IDR",
    "additionalInfo":
    {
        "status": "1",
        "message": "Success"
    }
}

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

Parameter
Data Type
Description

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

Parameter
Data Type
Description

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

{
   "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"
   }
}
{
   "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",
      "latestTransactionStatus":"03",
      "transactionStatusDesc":"Pending"
   }
}

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

Parameter
Data Type
Description

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

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

{
   "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":"03",
   "transactionStatusDesc":"Pending",
   "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 /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

Parameter
Data Type
Description

accountNo*

String (10)

Partner’s Sendme Account number

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

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

{
   "accountNo":"7382382957893840"
}
{
   "responseCode":"2001100",
   "responseMessage":"Request has been processed successfully",
   "accountNo":"115471119",
   "accountInfos":[
      {
         "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 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

Parameter
Data Type
Description

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

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

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

{
   "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"
               }
            }
         ],
         "latestTransactionStatus":"03",
         "type":"PAYMENT",
         "additionalInfo":{
               "debitCredit":"D"
         }
      }
   ],
   "additionalInfo":{
      "accountNo":"9920015307",
      "fromDateTime":"2019-07-03T12:08:56-07:00",
      "toDateTime":"2019-07-03T12:08:56-07:00",
      "transactionStatusDesc":"Pending"
   }
}

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

Parameter
Data Type
Description

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

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

{
   "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"
   }
}
{
   "responseCode":"2003800",
   "responseMessage":"Request has been processed successfully",
   "referenceNo":"2020102977770000000009",
   "partnerReferenceNo":"2020102900000000000001",
   "customerNumber":"628187366363",
   "amount":{
      "value":"12345678.00",
      "currency":"IDR"
   },
   "additionalInfo":{
      "sourceAccount":"9920011089",
      "platformCode":"ovo",
      "beneficiaryEmail":"john.doe@faspay.co.id",
      "transactionDate":"2020-12-21T17:01:11+07:00",
      "instructDate":"",
      "transactionDescription":"Transfer",
      "callbackUrl":"http://abc.com/account/api/mail/sendtotele",
      "transactionReference":"O4wgHmwglqpFAv-hZiu-_9999980300009258",
      "latestTransactionStatus":"03",
      "transactionStatusDesc":"Pending"
   }
}

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

Name
Type
Description

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

Parameter
Data Type
M/O/C
Descriptions

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’

{
   "originalPartnerReferenceNo":"2021072342358089475892734",
   "originalReferenceNo":"2021072342358089475892091",
   "serviceCode":"38"
}
{
   "responseCode":"2003900",
   "responseMessage":"Request has been processed successfully",
   "originalPartnerReferenceNo":"2021072342358089475892734",
   "originalReferenceNo":"2021072342358089475892091",
   "serviceCode":"38",
   "amount":{
      "value":"12345678.00",
      "currency":"IDR"
   },
   "latestTransactionStatus":"03",
   "transactionStatusDesc":"Pending",
   "additionalInfo":{
      "sourceAccount":"9920017573",
      "transactionDate":"2020-12-21T17:01:11+07:00",
      "platformCode":"gpy",
      "platformName":"Gopay",
      "customerNumber":"9998877766",
      "customerName":"Felicia",
      "transactionDescription":"Transfer",
      "callbackUrl":" http://abc.com/account/api/mail/sendtotele",
      "transactionStatusDate":"2020-12-21T17:01:11+07:00"
   }
}

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:

Parameter
M/O/C
Data Type
Length
Description

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

{
  "partnerReferenceNo": "1723105206783",
  "partnerServiceId": "     126",
  "customerNo": "085212344321",
  "virtualAccountNo": "126085212344321",
  "additionalInfo": {
    "billerCode": "014",
    "sourceAccount": "9920011089"
  }
}

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:

SNAP Parameter
M/O/C
Data Type
Length
Description

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

{
  "responseCode": "2003200",
  "responseMessage": "Request has been processed successfully",
  "virtualAccountData": {
    "partnerServiceId": "     126",
    "customerNo": "085212344321",
    "virtualAccountNo": "126085212344321",
    "virtualAccountName": "fXXXXXXXXXXXXXs",
    "totalAmount": {
      "value": "11500.00",
      "currency": "IDR"
    },
    "virtualAccountTrxType": "C",
    "partnerReferenceNo": "1723105206783"
  },
  "additionalInfo": {
    "billerCode": "014",
    "sourceAccount": "9920011089",
    "status": "2",
    "message": "Success"
  }
}

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:

Parameter
M/O/C
Data Type
Length
Description

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.

{
  "partnerReferenceNo": "1723105403186",
  "partnerServiceId": "     126",
  "customerNo": "085212344321",
  "virtualAccountNo": "126085212344321",
  "virtualAccountName": "fXXXXXXXXXXXXXs",
  "sourceAccount": "9920011089",
  "paidAmount": {
    "value": "11500.00",
    "currency": "IDR"
  },
  "trxDateTime": "2024-08-08T15:23:23",
  "additionalInfo": {
    "billerCode": "014",
    "instructDate": "",
    "callbackUrl": "http://account-service/account/api/mail/sendtotele"
  }
}

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:

Parameter
M/O/C
Data Type
Length
Description

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

{
  "responseCode": "2003300",
  "responseMessage": "Request has been processed successfully",
  "virtualAccountData": {
    "partnerReferenceNo": "1723105403186",
    "referenceNo": "4147193",
    "partnerServiceId": "     126",
    "customerNo": "085212344321",
    "virtualAccountNo": "126085212344321",
    "virtualAccountName": "fXXXXXXXXXXXXXs",
    "sourceAccount": "9920011089",
    "paidAmount": {
      "value": "11500.00",
      "currency": "IDR"
    },
    "trxDateTime": "2024-08-08T15:23:23"
  },
  "additionalInfo": {
    "billerCode": "014",
    "instructDate": "",
    "callbackUrl": "
http://account-service/account/api/mail/sendtotele"
,
    "status": "1",
    "message": "On Process"
  }
}
PreviousSNAP QRISNextResponse Code

Last updated 3 months ago

Signature details .

here