Top Up Callback

Register your Top Up Callback URL and get Top Up notification from your Account or Sub-Account

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": "MERCHANT-TOP-UP.SUCCESS",
  "data": {
    "merchantId": "293b3e10-a973-42dc-864a-46f615dd0690",
    "merchantName": "Test Widya",
    "accountName": "DISBURSEMENT",
    "amount": {
      "currency": "IDR",
      "value": "100000"
    },
    "balanceBefore": {
      "currency": "IDR",
      "value": "500000"
    },
    "balanceAfter": {
      "currency": "IDR",
      "value": "600000"
    },
    "paymentMethod": {
      "type": "VIRTUAL_ACCOUNT"
    },
    "paymentMethodOptions": {
      "virtualAccount": {
        "channel": "PERMATA",
        "virtualAccountNumber": "7664011855050926",
        "virtualAccountName": "TW"
      }
    },
    "transactionTime": "2025-05-14T08:52:20.832448Z"
  }
}

Detail Parameter Request

Parameter
Data Type
Requirement
Description

event

String

M

Event name: MERCHANT-TOP-UP.SUCCESS

merchantId

String

M

Unique merchant ID given by Pivot

merchantName

String

M

Merchant Name information

accountName

String

M

Topped-up Account Balance

amount

Object

M

  • currency

String

M

Currency code in ISO 4217 Format, e.g. USD, IDR

  • value

String

M

Top Up amount value

balanceBefore

Object

M

Balance before Top Up

  • currency

String

M

Currency code in ISO 4217 Format, e.g. USD, IDR

  • value

String

M

Balance before Top Up value

balanceAfter

Object

M

Balance after Top Up

  • currency

String

M

Currency code in ISO 4217 Format, e.g. USD, IDR

  • value

String

M

Balance after Top Up value

paymentMethod

Object

M

  • type

String

M

Available payment method types to Top Up , possible values are

  • VIRTUAL_ACCOUNT

paymentMethodOptions

Object

M

  • virtualAccount

Object

M

>> channel

String

M

Virtual Account Bank Name, possible values are

  • PERMATA

  • BRI

  • MANDIRI

  • CIMB

  • BNC

  • etc

>> virtualAccountNumber

String

M

The corresponding virtual account number that can be used to Top Up

>> virtualAccountName

String

M

For Main Account & Non KYC Sub-Account:

Virtual Account Name will use merchant name For KYC Sub-Account: Virtual Account Name will use Sub-Account name

transactionTime

String

M

When Top Up transaction time with format YYYY-MM-DDTHH:MM:SSZ

Last updated