Payment Callback

Register your Payment Callback URL and get Payment status

POST www.yourcompany.com/payment_callback_url

Request

Header Request

Parameter
Data Type
Requirement
Description

X-API-Key

String

M

Callback API Key, an additional API Key used specifically for receiving callbacks

Content-Type

String

M

application/JSON

Accept

String

M

application/JSON

Request Body

{
  "event": "PAYMENT.PAID",
  "data": {
    "id": "c09ec1fd-e19e-4a84-ba1e-0b4a8f6283ee",
    "clientReferenceId": "1739961335",
    "paymentUrl": "https://pivot.payment-page.com/payment",
    "status": "PAID",
    "autoConfirm": true,
    "mode": "REDIRECT",
    "redirectUrl": {
      "successReturnUrl": "https://merchant.com/success",
      "failureReturnUrl": "https://merchant.com/failure",
      "expirationReturnUrl": "https://merchant.com/expired"
    },
    "amount": {
      "value": 100000,
      "currency": "IDR"
    },
    "paymentMethod": {
      "type": "CARD"
    },
    "statementDescriptor": "merchant short name",
    "chargeDetails": [
      {
        "id": "c09ec1fd-e19e-4a84-ba1e-0b4a8f6283xx",
        "paymentSessionId": "c09ec1fd-e19e-4a84-ba1e-0b4a8f6283ee",
        "paymentSessionClientReferenceId": "1739961335",
        "amount": {
          "value": 100000,
          "currency": "IDR"
        },
        "statementDescriptor": "merchant short name",
        "status": "SUCCESS",
        "authorizedAmount": {
          "value": 100000,
          "currency": "IDR"
        },
        "capturedAmount": {
          "value": 100000,
          "currency": "IDR"
        },
        "isCaptured": true,
        "createdAt": "2024-12-19T13:22:32Z",
        "updatedAt": "2024-12-19T13:22:32Z",
        "paidAt": "2024-12-19T13:22:32Z",
        "card": {
          "first6": "412345",
          "first8": "41234567",
          "last4": "0987",
          "expMonth": "01",
          "expYear": "29",
          "fingerprint": "5d760e51-7168-4c66-9785-fcbc97d7dee9",
          "binInformations": {
            "type": "CREDIT",
            "issuingBank": "PT BANK RAKYAT INDONESIA TBK",
            "brand": "VISA",
            "country": "ID"
          },
          "authenticationResult": {
            "threeDsVersion": "2.2.0",
            "threeDsResult": "SUCCESSFUL",
            "threeDsMethod": "CHALLENGE"
          },
          "authorizationResult": {
            "avsResult": "NOT_SUPPORTED",
            "cvvResult": "MATCHED",
            "authorizedAmount": {
              "value": 100000,
              "currency": "IDR"
            },
            "issuerAuthorizationCode": "00"
          }
        }
      }
    ],
    "createdAt": "2024-12-19T13:22:32Z",
    "updatedAt": "2024-12-19T13:22:32Z",
    "expiryAt": "2025-03-15T09:37:00Z"
  }
}

Detail Parameter Request

Parameter
Data Type
Requirement
Description

event

String

M

List of Event name: 1. PAYMENT.PROCESSING 2. PAYMENT.PAID 3. PAYMENT.CANCELLED

Payment Session

Object

M

Last updated