Build Full API Mode
Applicable only for QRIS and Virtual Account
Finalize Payment Method early
If you choose autoConfirm = true, The payment will be automatically confirmed after you complete the API mode flow — no additional confirmation step is needed
Create Payment Session
A windowed time for the end customer to complete the payment, starting when the client initiates the payment request through your app. The payment session duration is customizable, with a default duration of 15 minutes.
API Reference: Create Payment Session
POST [BASE_URL]/v2/payments
{
"clientReferenceId": "1751610085",
"amount": {
"value": 10000,
"currency": "IDR"
},
"paymentMethod": {
"type": "VIRTUAL_ACCOUNT"
},
"paymentMethodOptions": {
"virtualAccount": {
"channel": "PERMATA",
"virtualAccountName": "Reforza Pivot",
"virtualAccountNumber": "99996662",
"expiryAt": "2025-12-30T23:59:00Z"
}
},
"mode": "API",
"redirectUrl": {
"successReturnUrl": "https://merchant.com/success",
"failureReturnUrl": "https://merchant.com/failure",
"expirationReturnUrl": "https://merchant.com/expiration"
},
"customer": {
"givenName": "Reforza Jordan",
"sureName": "Geotama",
"email": "reforza@pivot-payment.com",
"phoneNumber": {
"countryCode": "+62",
"number": "89699990001"
},
"refundPreference": {
"method": "AUTO",
"transferDestination": {
"channelCode": "014",
"channelInformation": {
"accountNumber": "17677665415",
"accountName": "Reforza Jordan Geotama"
}
}
}
},
"orderInformation": {
"productDetails": [
{
"type": "PHYSICAL",
"category": "FASHION",
"subCategory": "FASHION WANITA",
"name": "Dress Kasual Warna Putih",
"description": "Ukuran M",
"quantity": 1,
"price": {
"value": 100000,
"currency": "IDR"
}
}
],
"billingInfo": {
"givenName": "Reforza Jordan",
"sureName": "Geotama",
"email": "reforza@pivot-payment.com",
"phoneNumber": {
"countryCode": "+62",
"number": "89699990001"
},
"addressLine1": "Biomedical Building Lantai 3",
"addressLine2": "Digital hub, BSD City",
"city": "Tangerang Regency",
"provinceState": "Banten",
"country": "ID",
"postalCode": "15331"
},
"shippingInfo": {
"givenName": "Reforza Jordan",
"sureName": "Geotama",
"email": "reforza@pivot-payment.com",
"phoneNumber": {
"countryCode": "+62",
"number": "89699990001"
},
"addressLine1": "Biomedical Building Lantai 3",
"addressLine2": "Digital hub, BSD City",
"city": "Tangerang Regency",
"provinceState": "Banten",
"country": "ID",
"postalCode": "15331",
"method": "REGULAR",
"shippingFee": {
"value": 100000,
"currency": "IDR"
}
}
},
"autoConfirm": true,
"statementDescriptor": "Reforza Pivot",
"expiryAt": "2025-12-30T23:59:00Z",
"metadata": {
"invoiceNo": "INV001"
}
}Define Payment Method
Set autoConfirm to true and fill paymentMethod and paymentMethodOptions Object to finalize the payment method from the previous step
Object Reference:
{
"paymentMethod": {
"type": "VIRTUAL_ACCOUNT"
},
"paymentMethodOptions": {
"virtualAccount": {
"channel": "PERMATA",
"virtualAccountName": "Reforza Pivot",
"virtualAccountNumber": "99996662",
"expiryAt": "2025-12-30T23:59:00Z"
}
},
"autoConfirm": true
}Fill Customer and Order information
Include customer and order details by filling the customer and orderInformation objects. Personalize the payment experience, enhance fraud detection and reconciliation, and ensure smoother processing of refund requests.
Object Reference:
{
"customer": {
"givenName": "Reforza Jordan",
"sureName": "Geotama",
"email": "reforza@pivot-payment.com",
"phoneNumber": {
"countryCode": "+62",
"number": "89699990001"
},
"refundPreference": {
"method": "AUTO",
"transferDestination": {
"channelCode": "014",
"channelInformation": {
"accountNumber": "17677665415",
"accountName": "Reforza Jordan Geotama"
}
}
}
},
"orderInformation": {
"productDetails": [
{
"type": "PHYSICAL",
"category": "FASHION",
"subCategory": "FASHION WANITA",
"name": "Dress Kasual Warna Putih",
"description": "Ukuran M",
"quantity": 1,
"price": {
"value": 100000,
"currency": "IDR"
}
}
],
"billingInfo": {
"givenName": "Reforza Jordan",
"sureName": "Geotama",
"email": "reforza@pivot-payment.com",
"phoneNumber": {
"countryCode": "+62",
"number": "89699990001"
},
"addressLine1": "Biomedical Building Lantai 3",
"addressLine2": "Digital hub, BSD City",
"city": "Tangerang Regency",
"provinceState": "Banten",
"country": "ID",
"postalCode": "15331"
},
"shippingInfo": {
"givenName": "Reforza Jordan",
"sureName": "Geotama",
"email": "reforza@pivot-payment.com",
"phoneNumber": {
"countryCode": "+62",
"number": "89699990001"
},
"addressLine1": "Biomedical Building Lantai 3",
"addressLine2": "Digital hub, BSD City",
"city": "Tangerang Regency",
"provinceState": "Banten",
"country": "ID",
"postalCode": "15331",
"method": "REGULAR",
"shippingFee": {
"value": 100000,
"currency": "IDR"
}
}
}
}Get Payment Information details
After creating the Payment Session, display the payment information details on your customized Payment page, which is returned in the response.
Object Reference: Charge Object
{
"chargeDetails": [
{
"id": "b4db4aa5-4ee4-4722-b414-050c745c93cd",
"paymentSessionId": "7f65c757-355f-4645-ac14-028b34ab51b1",
"paymentSessionClientReferenceId": "1751610085",
"amount": {
"value": 10000,
"currency": "IDR"
},
"statementDescriptor": "",
"status": "WAITING_FOR_USER_ACTION",
"authorizedAmount": null,
"capturedAmount": null,
"isCaptured": false,
"createdAt": "2025-03-30T05:48:17.105883834Z",
"updatedAt": "2025-03-30T05:48:17.105883916Z",
"paidAt": null,
"virtualAccount": {
"channel": "PERMATA",
"virtualAccountNumber": "76630099996662",
"virtualAccountName": "Reforza Pivot",
"expiryAt": "2025-03-30T23:59:05Z"
}
}
]
}Finalize Payment Method later
If you choose autoConfirm = false, Payment Method can be submitted later during the confirmation step using the confirm API
Create Payment Session
A windowed time for the end customer to complete the payment, starting when the client initiates the payment request through your app. The payment session duration is customizable, with a default duration of 15 minutes.
API Reference: Create Payment Session
POST [BASE_URL]/v2/payments
{
"clientReferenceId": "1751612565",
"amount": {
"value": 10000,
"currency": "IDR"
},
"mode": "API",
"redirectUrl": {
"successReturnUrl": "https://merchant.com/success",
"failureReturnUrl": "https://merchant.com/failure",
"expirationReturnUrl": "https://merchant.com/expiration"
},
"customer": {
"givenName": "Reforza Jordan",
"sureName": "Geotama",
"email": "reforza@pivot-payment.com",
"phoneNumber": {
"countryCode": "+62",
"number": "89699990001"
},
"refundPreference": {
"method": "AUTO",
"transferDestination": {
"channelCode": "014",
"channelInformation": {
"accountNumber": "17677665415",
"accountName": "Reforza Jordan Geotama"
}
}
}
},
"orderInformation": {
"productDetails": [
{
"type": "PHYSICAL",
"category": "FASHION",
"subCategory": "FASHION WANITA",
"name": "Dress Kasual Warna Putih",
"description": "Ukuran M",
"quantity": 1,
"price": {
"value": 100000,
"currency": "IDR"
}
}
],
"billingInfo": {
"givenName": "Reforza Jordan",
"sureName": "Geotama",
"email": "reforza@pivot-payment.com",
"phoneNumber": {
"countryCode": "+62",
"number": "89699990001"
},
"addressLine1": "Biomedical Building Lantai 3",
"addressLine2": "Digital hub, BSD City",
"city": "Tangerang Regency",
"provinceState": "Banten",
"country": "ID",
"postalCode": "15331"
},
"shippingInfo": {
"givenName": "Reforza Jordan",
"sureName": "Geotama",
"email": "reforza@pivot-payment.com",
"phoneNumber": {
"countryCode": "+62",
"number": "89699990001"
},
"addressLine1": "Biomedical Building Lantai 3",
"addressLine2": "Digital hub, BSD City",
"city": "Tangerang Regency",
"provinceState": "Banten",
"country": "ID",
"postalCode": "15331",
"method": "REGULAR",
"shippingFee": {
"value": 100000,
"currency": "IDR"
}
}
},
"autoConfirm": false,
"statementDescriptor": "Reforza Pivot",
"expiryAt": "2025-12-30T23:59:00Z",
"metadata": {
"invoiceNo": "INV001"
}
}Fill Customer and Order information
Include customer and order details by filling the customer and orderInformation objects. Personalize the payment experience, enhance fraud detection and reconciliation, and ensure smoother processing of refund requests.
Object Reference:
{
"customer": {
"givenName": "Reforza Jordan",
"sureName": "Geotama",
"email": "reforza@pivot-payment.com",
"phoneNumber": {
"countryCode": "+62",
"number": "89699990001"
},
"refundPreference": {
"method": "AUTO",
"transferDestination": {
"channelCode": "014",
"channelInformation": {
"accountNumber": "17677665415",
"accountName": "Reforza Jordan Geotama"
}
}
}
},
"orderInformation": {
"productDetails": [
{
"type": "PHYSICAL",
"category": "FASHION",
"subCategory": "FASHION WANITA",
"name": "Dress Kasual Warna Putih",
"description": "Ukuran M",
"quantity": 1,
"price": {
"value": 100000,
"currency": "IDR"
}
}
],
"billingInfo": {
"givenName": "Reforza Jordan",
"sureName": "Geotama",
"email": "reforza@pivot-payment.com",
"phoneNumber": {
"countryCode": "+62",
"number": "89699990001"
},
"addressLine1": "Biomedical Building Lantai 3",
"addressLine2": "Digital hub, BSD City",
"city": "Tangerang Regency",
"provinceState": "Banten",
"country": "ID",
"postalCode": "15331"
},
"shippingInfo": {
"givenName": "Reforza Jordan",
"sureName": "Geotama",
"email": "reforza@pivot-payment.com",
"phoneNumber": {
"countryCode": "+62",
"number": "89699990001"
},
"addressLine1": "Biomedical Building Lantai 3",
"addressLine2": "Digital hub, BSD City",
"city": "Tangerang Regency",
"provinceState": "Banten",
"country": "ID",
"postalCode": "15331",
"method": "REGULAR",
"shippingFee": {
"value": 100000,
"currency": "IDR"
}
}
}
}Confirm Payment Session
If you set autoConfirm to false on the Create Payment Session API, you can finalize the Payment Method by filling paymentMethod and paymentMethodOptions objects
API Reference: Confirm Payment Session
POST [BASE_URL]/v2/payments/{id}/confirm
{
"paymentMethod": {
"type": "VIRTUAL_ACCOUNT"
},
"paymentMethodOptions": {
"virtualAccount": {
"channel": "PERMATA",
"virtualAccountName": "Reforza Pivot",
"virtualAccountNumber": "99996662",
"expiryAt": "2025-12-30T23:59:00Z"
}
}
}Get Payment Information details
After confirming the Payment Session, display the payment information details on your customized Payment page, which is returned in the response.
Object Reference: Charge Object
{
"chargeDetails": [
{
"id": "b4db4aa5-4ee4-4722-b414-050c745c93cd",
"paymentSessionId": "7f65c757-355f-4645-ac14-028b34ab51b1",
"paymentSessionClientReferenceId": "1751610085",
"amount": {
"value": 10000,
"currency": "IDR"
},
"statementDescriptor": "",
"status": "WAITING_FOR_USER_ACTION",
"authorizedAmount": null,
"capturedAmount": null,
"isCaptured": false,
"createdAt": "2025-03-30T05:48:17.105883834Z",
"updatedAt": "2025-03-30T05:48:17.105883916Z",
"paidAt": null,
"virtualAccount": {
"channel": "PERMATA",
"virtualAccountNumber": "76630099996662",
"virtualAccountName": "Reforza Pivot",
"expiryAt": "2025-03-30T23:59:05Z"
}
}
]
}Last updated