| Path | /ordersnap/api/v1.0/transfer-va/create-va |
|---|
| HTTP Method | POST |
| Version | v1.0 |
| Service Code | 27 |
| Field Name | Field Type | Mandatory | Field Description |
|---|
| Content-type | String | M | Media type of the resource, i.e. application/json |
| X-TIMESTAMP | String | M | Client’s current local time in ISO-8601 format |
| X-SIGNATURE | String | M | Created using symmetric signature HMAC_SHA512 algorithm. Read here |
| Authorization | String | M | Represents access_token of a request; string starts with keyword “Bearer ” followed by access_token. Can get this token from Access Token B2B response. Read here |
| X-PARTNER-ID | String | M | API Key / Client ID merchant (Web Merchant > Pengaturan > System Setting > tab Security Key) |
| X-EXTERNAL-ID | String | M | Merchant’s unique ID per transaction request |
| CHANNEL-ID | String | M | PJP’s channel id. |
Example Header
| Field Name | Value |
|---|
| Content-type | application/json |
| X-TIMESTAMP | 2024-03-19T14:30:00+07:00 |
| X-SIGNATURE | da1fa417c72d6b91c257e01e54fac824 |
| Authorization | Bearer gp9HjjEj813Y9JGoqwOeOPWbnt4CupvIJbU1Mmu4a11MNDZ7Sg5u9a |
| X-PARTNER-ID | 7fb118fb-2738-4886-9817-8a2c4de43001 |
| X-EXTERNAL-ID | 41807553358950093184162180797837 |
| CHANNEL-ID | 95221 |
| Field Name | Field Type | Mandatory | Field Description |
|---|
| virtualAccountName | String(255) | M | The customer name. |
| virtualAccountEmail | String(255) | M | The customer’s email. |
| virtualAccountPhone | String(30) | M | The customer’s phone number. |
| trxId | String(36) | M | Transaction ID in Partner system |
| totalAmount | Object | M | |
| totalAmount.value | String (16, 2) | M | Transaction Amount. |
| totalAmount.currency | String (3) | M | The currency of the value paid. Should be IDR. |
| billDetails | Array of Object | M | Billing address detail. |
| billDetails.billCode | String | O | Billing address code. |
| billDetails.billNo | String | O | Billing address number. |
| billDetails.billName | String | M | Billing address name. |
| billDetails.billShortName | String | O | Billing address short name. |
| billDetails.billDescription | Object | O | Bill Description |
| billDetails.billDescription.english | String | O | English version description. |
| billDetails.billDescription.indonesia | String | O | Bahasa version description. |
| billDetails.billSubCompany | String | O | Partner's product code |
| billDetails.billAmount | Object | O | |
| billDetails.billAmount.value | String | M | The numeric string of the amount up to two decimal places. |
| billDetails.billAmount.currency | String | M | Currency of bill amount based on ISO 4217 |
| billDetails.additionalInfo | Object | M | Additional Information |
| expiredDate | String | M | Expired Date transaction. |
| addtionalInfo | Object | M | Additional Information |
| addtionalInfo.enabledh2hpayments | Integer | M | Enable H2H Payments. |
{
"virtualAccountName": "Jokul Doe",
"virtualAccountEmail": "[email protected]",
"virtualAccountPhone": "6281828384858",
"trxId": "test1",
"totalAmount": {
"value": "12345678.00",
"currency": "IDR"
},
"billDetails": [
{
"billCode": "01",
"billNo": "123456789012345678",
"billName": "Bill A for Jan",
"billShortName": "Bill A",
"billDescription": {
"english": "Maintenance",
"indonesia": "Pemeliharaan"
},
"billSubCompany": "00001",
"billAmount": {
"value": "12345678.00",
"currency": "IDR"
},
"additionalInfo": {}
}
],
"expiredDate": "2024-08-23T07:44:11+07:00",
"additionalInfo": {
"enabledh2hpayments": 4
}
}
| | | |
|---|
| referenceNo | String | M | Number Reference |
| responseCode | String(7) | M | Status code of transaction charge result. |
| responseMessage | String(150) | M | Description of transaction charge result. |
| virtualAccountData | Object | M | Object Virtual Account Data |
| virtualAccountData.virtualAccountNo | String(28) | M | partnerServiceId (8 digit left padding space) + customerNo (up to 20 digits). partnerServiceId + customerNo or virtualAccountNo |
{
"referenceNo": "T24110664549",
"responseCode": "2002700",
"responseMessage": "Request has been processed successfully",
"virtualAccountData": {
"virtualAccountNo": "2035241100000664549"
}
}
| Response Code | HTTP Status | Description |
|---|
| 2002700 | 200 | Successful |
| 4002701 | 400 | Invalid Field Format {field name} |
| 4002702 | 400 | Invalid Mandatory Field {field name} |
| 4012701 | 401 | Invalid Token (B2B) |
| 4012700 | 401 | Unauthorized. [Reason] |
| 4092700 | 409 | Conflict |
| 4092701 | 409 | Duplicate partnerReferenceNo |
| 5005100 | 500 | General Error |