SNAP QRIS

API Services

Header

Header Request

Header parameters for transaction request.

Field

M/O/C

Data Type

Description

Content-Type

Mandatory

String

String represents indicate the media type of the resource (e.g. application/json, application/pdf)

X-TIMESTAMP

Mandatory

String

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

X-SIGNATURE

Mandatory

String

Represents signature of a request.

Signature details .

ORIGIN

Optional

String

Origin Domain www.yourdomain.com

X-PARTNER-ID

Mandatory

String

(5)

Unique ID for a partner. merchant_id mapped here

X-EXTERNAL-ID

Mandatory

String (36)

Numeric String. Reference number that should be unique in the same day

CHANNEL-ID

Mandatory

String

(5)

Faspay’s channel id

Device identification on which the API services is currently being accessed by the end user (customer)

Header Response

Header parameters for transaction response.

Field

Attribute

Data Type

Description

Content-Type

Mandatory

String

application/json

X-TIMESTAMP

Mandatory

String

Client's current local time in yyyy-MMddTHH: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  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

Body

Generate QRIS

POST /{version}/qr/qr-mpm-generate

The QRIS API is used for generating QRIS code payments.

Service code -> 47 Current version -> v1.0 *is required

URL Path

Sandbox: https://debit-sandbox.faspay.co.id/v1.0/qr/qr-mpm-generate

Request Body

Parameter

Data Type

Description

partnerReferenceNo*

String (32)

Transaction identifier on service consumer system

amount

Object

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

value*

String (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 with 2 decimal (ISO4217)

currency*

String (3)

Currency

merchantId*

String (5)

Merchant identifier that is unique per each merchant

validityPeriod*

String (25)

The time when the QRIS valid.

(ISO-860)

additionalInfo

Object

Merchant identifier that is unique per each merchant

billDate*

String (25)

Transaction/ Order Date.

(ISO-8601)

billDescription*

String (128)

Bill description

channelCode*

String (32)

Payment Channel Code

List Channel Code:

715 Linkaja QRIS 711 ShopeePay QRIS 842 CIMB QRIS

phoneNo*

String (30)

Customer phone number

Response

Parameter

Data Type

Descriptions

responseCode*

String (7)

Response code

responseMessage*

String (150)

Response description

referenceNo*

String (16)

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

partnerReferenceNo*

String (32)

Transaction identifier on service consumer system

qrUrl

String (256)

QR URL for downloading QR

Image.

Will be returned only for direct merchant. Notes: type -> conditional

additionalInfo

Object

Additional information

qrImageUrl*

String (256)

Redirect URL to display QR Image in Faspay page.

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 (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 with 2 decimal (ISO4217)

currency*

String (3)

Currency

{
    "partnerReferenceNo": "2020102900000000000001",
    "amount":
    {
        "value": "1000.00",
        "currency": "IDR"
    },
    "merchantId": "99999",
    "validityPeriod": "2023-10-03T23:00:00+07:00",
    "additionalInfo":
    {
        "billDate": "2023-10-03T17:00:00+07:00",
        "billDescription": "Payment #12345678",
        "channelCode": "711",
        "phoneNo": "082123456789"
    }
}

{
    "responseCode": "2004700",
    "responseMessage": "Request has been processed successfully",
    "referenceNo": "1999971176208743",
    "partnerReferenceNo": "2020102900000000000001",
    "qrUrl":"https://debit-staging.faspay.co.id/__assets/qr/99999-1999971176208743.png",
    "additionalInfo":
    {
        "qrImageUrl":"https://debit-staging.faspay.co.id/pws/100003/0830000010100000/a32c3d417ec84d6e977484ab02192d26fd58563a?trx_id=1999971176208743&merchant_id=99999&bill_no=2020102900000000000001",
        "merchantId": "99999",
        "amount":
        {
            "value": "1000.00",
            "currency": "IDR"
        }
    }
}

Query Payment

POST /{version}/qr/qr-mpm-query

The query payment API is used to check the transaction status.

Service code: 51

Current version: v1.0

*is required

URL Path

Sandbox: https://debit-sandbox.faspay.co.id/v1.0/qr/qr-mpm-query

Request Body

Parameter

Data Type

Description

originalReferenceNo*

String(16)

Original transaction identifier on service provider system

channelCode*

String(32)

Payment Channel Code

List Channel Code:

715 Linkaja QRIS

711 ShopeePay QRIS 842 CIMB QRIS

additionalInfo

Object

Additional information

merchantId*

String(5)

Merchant identifier that is unique per each merchant

serviceCode*

String(2)

Transaction type indicator (service code of the original transaction request)

originalPartnerReferenceNo*

String(32)

Original transaction identifier on

service consumer system

Response

Parameter

M/O/C

Type

Descriptions

responseCode*

String (7)

Response code

responseMessage*

String (150)

Response description

originalReferenceNo*

String (16)

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

paidTime

DateTime (25)

Transaction date (yyyyMMddHHmmss) ISO-8601.

Notes: Type -> Conditional,Mandatory when payment Happened

amount

Object

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

value

String (16,2)

Amount of customer

payment. If it's IDR then

value includes 2 decimal

digits.

e.g. IDR 10.000,- will be placed with 10000.00.

Notes: Type -> Conditional, Mandatory when payment Happened, (ISO4217)

currency

String (3)

Currency Notes: Type -> Conditional,

originalPartnerReferenceNo*

String (32)

Original transaction identifier on service consumer system

serviceCode*

String (2)

Transaction type indicator (service code of the original transaction request)

latestTransactionStatus*

String (2)

Status code list:

00 - Success

01 - Initiated

03 - Pending

04 - Refunded

05 - Canceled

06 - Failed

07 - Not found 07 - Expired

transactionStatusDesc*

String (32)

Description status transaction

additionalInfo

Object

Additional information

paymentReff

String (16)

Payment Reff (from

Payment Channel).

Mandatory when payment

Happened

merchantId*

String (5)

Merchant identifier that is unique per each merchant

{
    "originalReferenceNo":"1999971176208743",
    "originalPartnerReferenceNo":"2020102900000000000001",
    "serviceCode":"47",
    "merchantId":"99999",
    "additionalInfo":{
        "channelCode":"711"
    }
}

{
    "responseCode": "2005100",
    "responseMessage": "Request has been processed successfully",
    "originalReferenceNo": "1999971176208743",
    "originalPartnerReferenceNo": "2020102900000000000001",
    "serviceCode": "47",
    "latestTransactionStatus": "00",
    "transactionStatusDesc": "Success",
    "paidTime":"2023-10-03 14:21:03",
    "amount":{
        "value":"1000.00",
        "currency":"IDR"
    }
    "additionalInfo": {
        "paymentReff":"158745496507764240"
        "merchantId": "99999"
    }
}

Payment Notification

Payment notification from Faspay to the merchant backend will also trigger an event of transaction status getting updated, to ensure merchant is securely informed. Please provide the URL and make sure it's already registered on Faspay system.

The detailed API reference can be found here

Integration Requirement

Integration needs API & Credential Key.

Response Code

Response status consists of 2 components, the code (response code) and the description (response message).

Component

Type

Length

Description

responseCode

String

response code = HTTP status code + service code + case code

responseMessage

String

150

API Services

Header

Header Request

Header Response

Body

Generate QRIS

Request Body

Response

Query Payment

Request Body

Response

Payment Notification

Integration Requirement

Response Code

Response Code List