Payment Session Object

{
  "id": "bca0b57a-391e-4f6f-bfef-8cd37492ee5b",
  "clientReferenceId": "1750758552",
  "amount": {
    "value": 10001,
    "currency": "IDR"
  },
  "autoConfirm": true,
  "mode": "REDIRECT",
  "redirectUrl": {
    "successReturnUrl": "https://merchant.com/success",
    "failureReturnUrl": "https://merchant.com/failed",
    "expirationReturnUrl": "https://merchant.com/expired"
  },
  "paymentMethod": {
    "type": "CARD"
  },
  "statementDescriptor": "Reforza Pivot",
  "status": "PAID",
  "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": {
          "acquirerReferenceNumber": "123456789",
          "retrievalReferenceNumber": "TRXCC7c364322b98717507589132",
          "stan": "104539",
          "avsResult": "",
          "cvvResult": "",
          "authorizedAmount": {
            "value": 10001,
            "currency": "IDR"
          },
          "issuerAuthorizationCode": "00"
        }
      }
    }
  ],
  "customerId": "999966660001",
  "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"
        }
      }
    },
    "storedPaymentMethods": [
      {
        "token": "bicbiweu63c",
        "paymentMethod": "ewallet",
        "paymentChannel": "dana",
        "createdAt": "2024-03-15T09:37:00Z",
        "status": "ACTIVE"
      },
      {
        "token": "bicewnbf3eu63c",
        "paymentMethod": "cards",
        "paymentChannel": "visa",
        "createdAt": "2024-06-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",
      "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"
      }
    }
  },
  "cancelledAt": null,
  "cancellationReason": null,
  "metadata": {
    "invoiceNo": "INV001"
  }
}

Detail Payment Session Object

Parameter
Data Type
Requirement
Description

id

String

Auto Generated

Unique ID of a payment session, generated by Pivot

clientReferenceId

Alphanumeric

M

Unique Payment Reference from Merchant's Request

amount

Object

M

Amount Object Total Payment amount

autoConfirm

Boolean

O

Default to true

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

mode

String

O

Default to REDIRECT

Payment Session mode. Possible values are:

  • REDIRECT will return redirectUrl

  • API

redirectUrl

Object

M

Redirect Object URL for redirection

paymentMethod

Object

O

statementDescriptor

String

O

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.

status

String

Auto Generated

createdAt

String

Auto Generated

Session created time with format YYYY-MM-DDTHH:MM:SSZ

updatedAt

String

Auto Generated

Session latest updated time with format YYYY-MM-DDTHH:MM:SSZ

expiryAt

String

O

Session expired time set by merchant with format YYYY-MM-DDTHH:MM:SSZ. The default expiration time is 15 mins.

encryptionKey

String

C

Only if :

  • paymentMethod.type = CARD

  • mode = API

  • autoConfirm = false

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

paymentUrl

String

C

Only If mode = REDIRECT

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

chargeDetails

Array of object

Auto Generated

Charge Object

Charged payments related to the payment session

customerId

String

O

Auto generated based on email as the unique identifier

customer

Object

M

Customer Object Customer Information

orderInformation

Object

M

Order Object Order Information

cancelledAt

String

Auto Generated

Session cancellation time with format YYYY-MM-DDTHH:MM:SSZ

cancellationReason

String

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

metadata

Object

O

Free object for merchant to store any extra information about the payment session

Last updated