> For the complete documentation index, see [llms.txt](https://pivot-payment.gitbook.io/pivot-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payments/object/payment-session-object.md). # Payment Session Object ```json { "id": "bca0b57a-391e-4f6f-bfef-8cd37492ee5b", "clientReferenceId": "1750758552", "amount": { "value": 10001, "currency": "IDR" }, "autoConfirm": true, "mode": "REDIRECT", "bypassStatusPage": false, "redirectUrl": { "successReturnUrl": "https://merchant.com/success", "failureReturnUrl": "https://merchant.com/failed", "expirationReturnUrl": "https://merchant.com/expired" }, "paymentType": "SINGLE", "paymentMethod": { "type": "CARD" }, "statementDescriptor": "Reforza Pivot", "expirationMode": "STRICT", "recurringId": "019d9570-eca8-706c-9bf8-e7c2dff99e39", "initiateFirstAuthorization": true, "saveForFutureUse": false, "showSavedPayment": false, "status": "PAID", "investigationStatus": null, "createdAt": "2025-03-30T05:48:17.0549468Z", "updatedAt": "2025-03-30T05:48:17.103243713Z", "expiryAt": "2025-03-31T23:59:05Z", "encryptionKey": "Eykc6QYeUuG5aKcPMrUsaZq0bWWCGLJY", "paymentUrl": "https://payment.pivot-payment.com/detail?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1dWlkIjoiN2Y2NWM3NTctMzU1Zi00NjQ1LWFjMTQtMDI4YjM0YWI1MWIxIiwiaXNzIjoiYmFja2VuZC1wb3J0YWwiLCJleHAiOjE3NDM0NjU1NDV9.55-QdvI0xVtivNLJzREPDGzUbqFNEj7ouFUCvrzAIbw", "chargeDetails": [ { "id": "cf2842f4-e263-4643-8bc9-af682a5060cd", "paymentSessionId": "bca0b57a-391e-4f6f-bfef-8cd37492ee5b", "paymentSessionClientReferenceId": "1750758552", "amount": { "value": 10001, "currency": "IDR" }, "statementDescriptor": "Reforza Pivot", "status": "SUCCESS", "authorizedAmount": { "value": 10001, "currency": "IDR" }, "capturedAmount": { "value": 10001, "currency": "IDR" }, "isCaptured": true, "createdAt": "2025-06-24T09:49:12.861006Z", "updatedAt": "2025-06-24T09:56:40.020691Z", "paidAt": "2025-06-24T09:56:39Z", "fdsRiskAssessment": { "score": "0", "level": "very low", "recommendation": "Approve", "status": "PASSED", "evaluatedAt": "2025-06-24T09:56:39.411921983Z" }, "card": { "first6": "999999", "first8": "99999966", "last4": "0001", "expMonth": "01", "expYear": "39", "fingerprint": "03765362-4f67-41c6-a6c7-4a7520dcbc36", "binInformations": { "type": "DEBIT", "issuingBank": "BRI", "brand": "VISA", "country": "ID" }, "authenticationResult": { "threeDsVersion": "2.2.0", "threeDsResult": "AUTHENTICATION_SUCCESSFUL", "threeDsMethod": "", "eciCode": "02" }, "authorizationResult": { "networkTransactionId": "", "acquirerReferenceNumber": "123456789", "retrievalReferenceNumber": "TRXCC7c364322b98717507589132", "stan": "104539", "avsResult": "", "cvvResult": "", "authorizedAmount": { "value": 10001, "currency": "IDR" }, "issuerAuthorizationCode": "00", "merchantAdviceCode": "01" }, "approvalCode": "869016", "isNetworkToken": false }, "captureHistories": [ { "captureId": "019c0862-dc89-73d6-b8f1-d790847b09ee", "currency": "IDR", "capturedAmount": 10001, "status": "SUCCESS", "createdAt": "2026-01-29T06:13:42Z" } ] } ], "customerId": "999966660001", "customer": { "givenName": "Reforza Jordan", "surname": "Geotama", "email": "reforza@pivot-payment.com", "phoneNumber": { "countryCode": "+62", "number": "89699990001" }, "refundPreference": { "method": "AUTO", "transferDestination": { "channelCode": "014", "channelInformation": { "accountNumber": "17677665415", "accountName": "Reforza Jordan Geotama" } } }, "storedPaymentMethods": [ { "token": "020027de-134e-45ed-8f0d-7ae0506a7133", "paymentMethod": "CARD", "paymentChannel": "VISA", "createdAt": "2025-09-02T06:02:59.141590124Z", "status": "ACTIVE", "card": { "fingerprint": "0198edcf-87a0-73fd-b937-7ec4b0ddb9c6", "network": "VISA", "first6": "444000", "first8": "44400001", "last4": "0002", "expMonth": "01", "expYear": "39", "cardHolderFirstName": "Reforza Jordan", "cardHolderLastName": "Geotama" } }, { "token": "bicbiweu63c", "paymentMethod": "ewallet", "paymentChannel": "dana", "createdAt": "2024-03-15T09:37:00Z", "status": "ACTIVE" } ] }, "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", "surname": "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", "surname": "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" } } }, "cancelledAt": null, "cancellationReason": null, "metadata": { "invoiceNo": "INV001" } } ``` **Detail Payment Session Object**
ParameterData TypeCharacter LimitRequirementDescription
idString-Auto GeneratedUnique ID of a payment session, generated by Pivot
clientReferenceIdAlphanumeric1-100MUnique Payment Reference from Merchant's Request
amountObject-M/pages/Foeq3eyfnM9O2anL1Vby
Total Payment amount
autoConfirmBoolean-O

Default to true


If the confirmation method is set to false. Then clients need to hit the /confirm endpoint

modeString-O

Default to REDIRECT

Payment Session mode. Possible values are:

  • REDIRECT will return redirectUrl
  • API
bypassStatusPageBoolean-O

Bypass Pivot's Status Page after your customer completing the Payment, directly redirect to your URLs

Default to false, applicable only for REDIRECT mode

Possible values are:

  • true
  • false
redirectUrlObject-M/pages/S8SLvqfKIqgU91J1gRyS

URL for redirection
paymentTypeString-O

Default to SINGLE

Payment Type possible values are:

  • SINGLE
  • MULTIPLE

Definition:

  • SINGLE: Payment Session can only be charged once
  • MULTIPLE: Payment Session can be charged multiple times, and Payment Session Status is always Active


Applicable only for Payment Method Type QR and VIRTUAL_ACCOUNT

paymentMethodObject-O/pages/yLhv0LHOksPwPOX2zgF3
statementDescriptorString0-20O

Default = Merchant’s short name

Statement descriptors allow a maximum 20 characters for all the concatenated characters (including space).

It will be shown on invoice, receipt, and for payment methods that support custom descriptors, it will be shown on the customer's bank statement.

expirationModeString-O

Default to LOOSE

Payment Type possible values are:

  • LOOSE
  • STRICT

Definition:

  • LOOSE: Expiry depends on processor rules
  • STRICT: Expiry depends on merchant rules


Applicable only for Payment Method Type CARD and EWALLET

recurringIdString-CUnique Recurring Reference

Applicable for subscription and automated billing integration
initiateFirstAuthorizationBoolean -C

Perform first authorization for new and updated Card information detail

Applicable for subscription and automated billing integration

Possible values are:

  • true
  • false
saveForFutureUseBoolean-O

Store Payment Information detail in Token format in /pages/lkA57A4pSG5HfyjfuzJr for CARD & EWALLET Payment method whenever the charge is SUCCESS

Default to false

Possible values are:

  • true
  • false
showSavedPaymentBoolean-O

Show saved Payment Information for CARD & EWALLET Payment method in Payment Redirection

Default to false, applicable only for REDIRECT mode

Possible values are:

  • true
  • false
statusString-Auto Generated/pages/W7VTq1fdG0erpZwAANlU
investigationStatusString-C

Applicable for the merchant who is eligible for Settlement Guarantee Program

Investigation Status:

  • INVESTIGATION_IN_PROCESS : Validating to our Bank Partner
  • INVESTIGATION_SUCCESS : Final Payment Status in our Bank Partner is SUCCESS
  • INVESTIGATION_FAILED : Final Payment Status in our Bank Partner FAILED
createdAtString-Auto GeneratedSession created time with format YYYY-MM-DDTHH:MM:SSZ
updatedAtString-Auto GeneratedSession latest updated time with format YYYY-MM-DDTHH:MM:SSZ
expiryAtString-OSession expired time set by merchant with format YYYY-MM-DDTHH:MM:SSZ. The default expiration time is 15 mins.

For Payment Type = MULTIPLE, don't necessarily send the Expiry At value
encryptionKeyString-C

Only if :

  • paymentMethod.type = CARD
  • mode = API
  • autoConfirm = false

To be used as Encryption of Customer's Card Information in Merchant FE

paymentUrlString-C

Only If mode = REDIRECT

Pivot will generate a Payment URL for merchant to redirect their user to the page

chargeDetailsArray of object-Auto Generated

/pages/aOBQzB2jzHoffHidS87v

Charged payments related to the payment session

customerIdString0-255OAuto generated based on email as the unique identifier
customerObject-M/pages/lkA57A4pSG5HfyjfuzJr

Customer Information
orderInformationObject-M/pages/VPbA2N3A4KfXIcUYnAtT

Order Information
cancelledAtString-Auto GeneratedSession cancellation time with format YYYY-MM-DDTHH:MM:SSZ
cancellationReasonString-O

Reason of cancellation, either provided by merchants or by Pivot System. Possible values

  • REQUESTED_BY_CUSTOMER - cancellation by end-customer
  • DUPLICATED - cancellation because of duplicated payment session
  • VOID_SESSION - cancellation by Merchant
  • CHARGE_FAILED - Session cancelled because user payment is rejected
  • FRAUDULENT - Session cancelled due to transaction marked as fraud
metadataObject-OFree object for merchant to store any extra information about the payment session