SNAP Direct Debit

This API is used to direct debit payment in SNAP standard for route payment.

URL Path

https://debit-sandbox.co.id/v1.0/debit/payment-host-to-host

Method

POST

Request Parameter

The parameters that must be provided by the merchant system to be accessed by the Faspay system are as follows:

SNAP Parameter	Data Type	M/O/C	Description
partnerReferenceNo	String (32)	M	Transaction identifier on service consumer system
bankCardToken	String (560)	M	Card token for payment. Notes: Used only for payment channel BRI Direct Debit
merchantId	String (5)	M	Merchant identifier that is unique per each merchant
amount	Object	O	An object that contains information about an amount or value within a specific context.
value	String (ISO4217) (16,2)	M	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)	M	Currency
validUpTo	String (25)	M	The time when the payment will be automatically expired. ISO 8601
additionalInfo	Object	O	Additional information
channelCode	String (32)	M	Payment Channel Code List Channel Code: 814: Maybank2U 704: SAKUKU 714: BRI Direct Debit 713: Shopeepay App 716: Linkaja App 812: OVO 819: DANA 700: CIMB Clicks 701: D-Bank Pro 401: BRI E-PAY 405: BCA KlikPay 302: LinkAja 722: DANA Subs 720: OVO OpenAPI
billDate	String (25)	M	Transaction/ Order Date ISO 8601
billDescription	String (128)	M	Bill description
phoneNo	String (30)	C	Customer Phone Number Notes: Mandatory for payment channel OVO Tokenized
route	Object	O
owner	Alphanumeric (32)	O	Registered partner id that owns/generates the transaction. Notes: 1 transaction only can contain 1 owner. If null, then the remaining transaction amount will belong to the merchant’s Sendme balance.
partnerId	Alphanumeric (32)	O	Merchant partner id number.
partnerAmount	Numeric (15)	C	Disbursement amount to partner.

SNAP Parameter

Data Type

M/O/C

Description

partnerReferenceNo

String (32)

Transaction identifier on

service consumer system

bankCardToken

String (560)

Card token for payment.

Notes:

Used only for payment channel BRI Direct Debit

merchantId

String (5)

Merchant identifier that is unique per each merchant

amount

Object

An object that contains information about an amount or value within a specific context.

value

String (ISO4217) (16,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

validUpTo

String (25)

The time when the payment will be automatically expired. ISO 8601

additionalInfo

Object

Additional information

channelCode

String (32)

Payment Channel Code

List Channel Code:

814: Maybank2U

704: SAKUKU

714: BRI Direct Debit

713: Shopeepay App

716: Linkaja App

812: OVO

819: DANA

700: CIMB Clicks

701: D-Bank Pro

401: BRI E-PAY

405: BCA KlikPay

302: LinkAja

722: DANA Subs

720: OVO OpenAPI

billDate

String (25)

Transaction/ Order Date

ISO 8601

billDescription

String (128)

Bill description

phoneNo

String (30)

Customer Phone Number

Notes:

Mandatory for payment channel OVO Tokenized

route

Object

owner

Alphanumeric (32)

Registered partner id that owns/generates the transaction.

Notes:

1 transaction only can contain 1 owner.
If null, then the remaining transaction amount will belong to the merchant’s Sendme balance.

partnerId

Alphanumeric (32)

Merchant partner id number.

partnerAmount

Numeric (15)

Disbursement amount to partner.

Sample Request

{
    "partnerReferenceNo": "2020102900000000000001",
    "bankCardToken": "thB9QgZkWx7asMCQG-QQO4hSwo6lAEN_cg5PEknI7mbwKCWIzR26QbXfytg",
    "merchantId": "99999",
    "amount":
    {
        "value": "10000.00",
        "currency": "IDR"
    },
    "validUpTo": "2024-09-19T13:44:11+07:00",
    "additionalInfo":
    {
        "channelCode": "713",
        "billDate": "2024-09-18T09:44:11+07:00",
        "billDescription": "SNAP Transaction",
        "phoneNo": "081274657847",
        "route":
        [
            {
                "owner": "26100253"
            },
            {
                "partnerId": "29195827",
                "partnerAmount": "4000.00"
            },
            {
                "partnerId": "andre-121321346",
                "partnerAmount": "5000.00"
            }
        ]
    }
}

Response Parameter

Response parameters are parameters that will be delivered by Faspay system in response to the request that have been sent by the merchant system. If no parameters appropriate/value are incorrect, the transaction will be rejected in the system Faspay.

SNAP Parameter	Data Type	M/O/C	Description
responseCode	String (7)	M	Response code. In details here.
responseMessage	String (150)	M	Response description. In details here.
referenceNo	String (16)	M	Transaction identifier on service provider system. Must be filled upon successful transaction
partnerReferenceNo	String (32)	M	Transaction identifier on service consumer system
webRedirectUrl	String (256)	C	Returns a universal link to PJP AIS Payment page. This link is recommended when the Client is unable to implement a check for whether PJP AlS app is installed on the user's device before redirect.
additionalInfo	Object	O	Additional information
merchantId	String (5)	M	Merchant identifier that is unique per each merchant
webUrl	String (256)	C	The redirect url for the next process, available only on JSON format
amount	Object	M	An object that contains information about an amount or value within a specific context.
value	String (ISO4217) (16,2)	M	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)	M	Currency
phoneNo	String (30)	C	Customer Phone Number Notes: Mandatory for payment channel OVO Tokenized
route	Object	O
owner	Alphanumeric (32)	O	Registered partner id that owns/generates the transaction. Notes: 1 transaction only can contain 1 owner. If null, then the remaining transaction amount will belong to the merchant’s Sendme balance.
partnerId	Alphanumeric (32)	O	Merchant partner id number.
partnerAmount	Numeric (15)	C	Disbursement amount to partner.

SNAP Parameter

Data Type

M/O/C

Description

responseCode

String (7)

Response code. In details here.

responseMessage

String (150)

Response description. In details here.

referenceNo

String (16)

Transaction identifier on service provider system. Must be filled upon successful transaction

partnerReferenceNo

String (32)

Transaction identifier on

service consumer system

webRedirectUrl

String (256)

Returns a universal link to PJP AIS Payment page. This link is recommended when the Client is unable to implement a check for whether PJP AlS app is installed on the user's device before redirect.

additionalInfo

Object

Additional information

merchantId

String (5)

Merchant

identifier that is unique per each merchant

webUrl

String (256)

The redirect url for the next process, available only on JSON format

amount

Object

An object that contains information about an amount or value within a specific context.

value

String (ISO4217) (16,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

phoneNo

String (30)

Customer Phone Number

Notes: Mandatory for payment channel OVO Tokenized

route

Object

owner

Alphanumeric (32)

Registered partner id that owns/generates the transaction.

Notes:

1 transaction only can contain 1 owner.
If null, then the remaining transaction amount will belong to the merchant’s Sendme balance.

partnerId

Alphanumeric (32)

Merchant partner id number.

partnerAmount

Numeric (15)

Disbursement amount to partner.

Sample Response

{
    "responseCode": "2005400",
    "responseMessage": "Request has been processed successfully",
    "referenceNo": "7139999977485726",
    "partnerReferenceNo": "2020102900000000000001",
    "webRedirectUrl": "https://debit-sandbox.faspay.co.id/pws/100003/0830000010100000/a32c3d417ec84d6e977484ab02192d26fd58563a?trx_id=7139999977485726&merchant_id=99999&bill_no=2020102900000000000001",
    "additionalInfo":
    {
        "merchantId": "99999",
        "webUrl": "https://id.uat.shp.ee/sppay_checkout_id?type=start&mid=265&target_app=shopee&medium_index=dFhkbmR1bTBIamhWlQPIZ0f7oKyc375eB2Pjxn0JFJYoIBfgOBAkou7PiN4gUSFdmALU6A&order_key=fGzalBB7xwdgcDLM5YUuqH6nQj8GTXSy404zjUBi38c6M_ynHIOnnqGCKvoKvV1u2I2vcIUDCOX2XQ&order_sn=157320763472767665&return_url=aHR0cHM6Ly9kZWJpdC1zdGFnaW5nLmZhc3BheS5jby5pZC9wd3Mvc2hvcGVlL3JldHVyblVybD9hbW91bnQ9MTAwMDAwMCZjbGllbnRfaWQ9RmFzcGF5JnJlZmVyZW5jZV9pZD03MTM5OTk5OTc3NDg1NzI2LTc3NTQ3OTMmcmVzdWx0X2NvZGU9MjAzJnNpZ25hdHVyZT1rN1JNSWZ0Yl9jRWMzLUllTVU3dk9yNEszNExvZ1U2NC1sU1dUME03aFpzJTNEJnRyeF91aWQ9NzEzOTk5OTk3NzQ4NTcyNg%3D%3D&source=web&token=dFhkbmR1bTBIamhWlQPIZ0f7oKyc375eB2Pjxn0JFJYoIBfgOBAkou7PiN4gUSFdmALU6A",
        "amount":
        {
            "value": "10000.00",
            "currency": "IDR"
        },
        "phoneNo": "081274657847",
        "route":
        [
            {
                "owner": "26100253"
            },
            {
                "partnerId": "29195827",
                "partnerAmount": "4000.00"
            },
            {
                "partnerId": "andre-121321346",
                "partnerAmount": "5000.00"
            }
        ]
    }
}

PreviousSNAP Create Virtual Account NextInquiry Static VA

Last updated 24 days ago