Glossary
QRIS SNAP
| Term / Field | Type | Description | Example |
|---|---|---|---|
| accessToken | Body | JWT token used for API authorization. | eyJraWQiOi... |
| additionalInfo | Body | Flexible field for custom metadata, such as device ID or channel. | { "deviceId": "12345679237", "channel": "mobilephone" } |
| amount.currency | Body | Currency code in ISO 4217 format. | IDR |
| amount.value | Body | Net transaction amount with 2 decimal places. | 12345678.00 |
| Authorization | Header | Bearer token used for API authentication. | Bearer eyJraWQiOi... |
| Bearer Token | Security | Standard format for the Authorization header. | Bearer eyJhbGciOi... |
| channel | Body | Channel source of the transaction. | mobilephone |
| Client ID | Security | Unique identifier for the partner provided during registration. | 962489e9-de5d-4eb7-92a4-b07d44d64bf4 |
| Client Secret | Security | Confidential key used to generate signatures and request tokens. | sdf8sd8f7sdf8sd... |
| Content-Type | Header | Media type of the request or response, usually application/json. | application/json |
| expiresIn | Body | Token lifetime in seconds. | 900 |
| externalStoreId | Body | External store identifier for cross-system mapping. | 124928924949487 |
| feeAmount.currency | Body | Currency code for the fee in ISO 4217 format. | IDR |
| feeAmount.value | Body | Transaction fee amount with 2 decimal places. | 12345678.00 |
| grantType | Body | OAuth 2.0 authorization method, usually client_credentials. | client_credentials |
| latestTransactionStatus | Body | Latest transaction status code. For example, 00 means success and 03 means pending. | 00 |
| originalExternalId | Body | External transaction identifier used for cross-reference. | 30443786930722726463280097920912 |
| originalPartnerReferenceNo | Body | Original transaction ID from the partner system. | 2020102900000000000001 |
| originalReferenceNo | Body | Original transaction ID from the service provider. | 2020102977770000000009 |
| paidTime | Body | Date and time when the payment was successfully completed. | 2020-12-06T14:53:22+07:00 |
| partnerReferenceNo | Body | Unique transaction reference number generated by the partner system. | 2020102900000000000001 |
| Private Key | Security | Secret cryptographic key generated by the partner and used to create digital signatures. | -----BEGIN PRIVATE KEY----- ... |
| Public Key | Security | Cryptographic key paired with the private key and shared with YUKK or ASPI to validate signatures. | -----BEGIN PUBLIC KEY----- ... |
| qrContent | Body | QRIS string in MPM format returned by the QR Generate API. | 0002010102112668... |
| referenceNo | Body | Transaction identifier generated by the acquirer or service provider. | 2020102977770000000009 |
| responseCode | Body | Standard code representing the outcome of an API request. | 2005200 |
| responseMessage | Body | Human-readable message that describes the responseCode. | Successful |
| serviceCode | Body | 2-digit transaction type code. | 47 |
| Signature / X-SIGNATURE | Security | Digital signature generated using SHA256withRSA to ensure integrity and non-repudiation. | 07abc7c30d245c0ecce3ef6c2a9ac76... |
| storeId | Body | Unique shop identifier in the merchant system. | abcd |
| Timestamp | Security | Time when the request was made, in ISO8601 format. | 2020-01-01T00:00:00+07:00 |
| tokenType | Body | Type of issued token, usually Bearer. | Bearer |
| transactionDate | Body | Date and time when the transaction was processed. | 2020-12-21T17:55:11+07:00 |
| transactionStatusDesc | Body | Description of the transaction status. | Success |
| X-CLIENT-KEY | Header | Client identifier provided after onboarding or registration. | 82150823919040624621823174737537 |
| X-EXTERNAL-ID | Header | Unique request ID generated by the partner system. | 41807553358950093184162180797837 |
| X-PARTNER-ID | Header | Unique identifier assigned to the partner by ASPI or YUKK. | 82150823919040624621823174737537 |
| X-SIGNATURE | Header | Header used to ensure request integrity and security using SHA256withRSA. | 85be817c55b2c135157c7e89f52499bf... |
| X-TIMESTAMP | Header | Request timestamp in ISO8601 format. | 2020-12-23T08:46:11+07:00 |
Virtual Account (H2H)
| Term / Field | Type | Description | Example |
|---|---|---|---|
| access_token / Access Token | Header / Security | Token used to authenticate API requests. It must be included in the HTTP header. | Bearer eyJhbGciOi... |
| amount | Body | Total transaction amount in IDR, usually using integer format without decimal. | 100000 |
| bank_code | Body | Bank identifier code used for Virtual Account payments. | 014 |
| callback_url | Body | Merchant URL endpoint used to receive asynchronous payment status notifications or webhook updates. | https://merchant.com/callback |
| Check Payment Status | API Endpoint | API endpoint used to check whether a payment is paid, waiting, canceled, or expired. | /check-payment-status |
| created_at | Body | Timestamp when the VA or payment request was created. | 2024-01-01 10:00:00 |
| currency | Body | Currency used in the transaction. The default currency is usually IDR. | IDR |
| customer_email | Body | Customer email address used for communication or receipt purposes. | customer@email.com |
| customer_id | Body | Unique identifier of the end customer provided by the merchant. | CUST001 |
| customer_name | Body | Full name of the customer. | John Doe |
| customer_phone | Body | Customer phone number, usually using Indonesian phone number format. | 081234567890 |
| description | Body | Transaction description or notes provided by the merchant. | Payment for invoice INV-001 |
| expired_time | Body | Overall expiration time for the transaction, after which the VA becomes invalid. | 2024-01-01 23:59:59 |
| HTTP Response Code | Response | HTTP status code returned by the API to indicate request success or failure. | 200 OK |
| merchant_id | Body / Credential | Unique identifier assigned to the merchant by YUKK. | MRC001 |
| Numeric String Unique per Day | Rule | Numeric string field that must be unique each day, commonly used as a reference ID or transaction identifier. | 202401010001 |
| payment_channel / Payment Channel | Body | Payment method or payment channel used for the transaction. | BCA VA |
| payment_date | Body | Date and time when the payment was successfully completed. | 2024-01-01 12:30:00 |
| reference_id | Body | Merchant-generated unique ID for each transaction. Usually numeric and must be unique per day. | 202401010001 |
| Request Payment | API Endpoint | API endpoint used to initiate a payment request. | /request-payment |
| Request VA via API | API Endpoint | API endpoint used to create a Virtual Account through an API request. | /request-va |
| response_code | Response | Response code returned by the API, such as HTTP status or system response code. | 200 |
| response_message | Response | Human-readable message that explains the response code. | Success |
| signature | Security | Security hash generated using merchant credentials for request validation. | a8f5f167f44f4964... |
| status | Body | Current transaction status. | WAITING, PAID, CANCELED, EXPIRED |
| Status CANCELED | Status | Status used when the VA or payment request has been canceled. | CANCELED |
| Status WAITING | Status | Status used when the VA or payment has not been paid yet and is still pending. | WAITING |
| transaction_id | Body | Unique transaction identifier generated by the YUKK system. | TRX123456789 |
| updated_at | Body | Timestamp when the transaction status was last updated. | 2024-01-01 12:35:00 |
| va_expired_time | Body | Expiry time for the Virtual Account. Usually in ISO 8601 or YYYY-MM-DD HH:mm:ss format. | 2024-01-01 23:59:59 |
| va_number | Body | Virtual Account number issued by the system to identify the VA payment. | 88081234567890 |
| Webhook Status Notification | Process | Push notification mechanism used by YUKK to notify the merchant when payment is completed or the status changes. | Payment notification sent to callback_url |