Payment Callback

PAPER.ID has a webhook which will send the payment status whenever there is an update. Please ensure that you have registered the URL callback on the dashboard in order to receive a callback from us.

This callback is catered for a successful/failed payment only, and not catering the disbursement process. The disbursement will be catered on different section (see: disbursement callback)

Parameter:

Path	Data Type Validation	Description
ref_id	string	Payment Transaction reference ID created by client
payment_date	date	Payment Date by customer / buyer in YYYY-MM-DD
message	string	Message response related to the payment data
payment_info	object	Payment data and details which had been made by customer / buyer
payment_info.method	string	The payment method used by customers. Currently we offer: bank_transfer, credit_card, ewallet, qris, mitra_pembayaran_digital.
payment_info.channel	string	The payment channel used by customer that identify which brand/channel that we used for identify specific payment method (e.g: visa, mastercard, ovo, bni, etc)
payment_info.amount	double	Billed amount that need to be paid by the customer
payment_info.paid_amount	double	Amount of payment that has been paid by the customer
payment_info.paid_at	timestamp	The time stamp of successful payment
payment_info.status	string	Payment transaction status. Expect that you will received PAID status for successful payment.
payment_info.updated	timestamp	The time stamp of latest update happens on the payment request
payment_info.source	string	The source of the underlying document. Default value: paper-chain, payment_out_request

JSON Payload

Bank Transfer

{
  "additional_info": {},
  "message": "transaction success",
  "payment_date": "01-01-2021 23:59:59",
  "payment_info": {
    "bank_transfer": {
      "amount": 200000,
      "created": "2021-08-09T11:23:50.550571+07:00",
      "paid_amount": 200000,
      "paid_at": "2021-08-09T11:23:50.550571+07:00",
      "status": "PAID",
      "updated": "2021-08-09T11:23:53.011389+07:00"
    },
    "channel": "bni",
    "method": "bank_transfer",
  },
  "ref_id": "987654xxxxx",
}

Credit Card

{
  "additional_info": null,
  "message": "transaction succeed",
  "payment_date": "2023-08-29",
  "payment_info": {
    "channel": "visa",
    "method": "credit_card",
    "credit_card": {
      "amount": 100000,
      "created": "2023-08-29T12:09:49.187348372+07:00",
      "paid_amount": 100000,
      "paid_at": "2023-08-29T12:10:51.143011605+07:00",
      "status": "PAID",
      "updated": "2023-08-29T12:10:51.143011605+07:00",
      "source": "paper-chain"
    }
  },
  "ref_id": "REF1693285783paQHF"
}

E-wallet

{
  "additional_info": null,
  "message": "transaction succeed",
  "payment_date": "2023-08-29",
  "payment_info": {
    "channel": "ewallet",
    "method": "OVO",
    "ewallet": {
      "amount": 100000,
      "created": "2023-08-29T12:12:58.750848281+07:00",
      "paid_amount": 100000,
      "paid_at": "2023-08-29T12:13:02.53221859+07:00",
      "status": "PAID",
      "updated": "2023-08-29T12:13:02.53221859+07:00",
      "source": "paper-chain"
    }
  },
  "ref_id": "REF1693285978PKnAn"
}

Mitra Pembayaran Digital

{
  "additional_info": null,
  "message": "transaction succeed",
  "payment_date": "2023-08-29",
  "payment_info": {
    "channel": "tokopedia", //or tokopedia_cc, blibli, shopee
    "method": "mitra_pembayaran_digital",
    "mitra_pembayaran_digital": {
      "amount": 100000,
      "created": "2023-08-29T11:53:12.475422622+07:00",
      "paid_amount": 100000,
      "paid_at": "2023-08-29T11:54:19.135087699+07:00",
      "status": "PAID",
      "updated": "2023-08-29T11:54:19.135087699+07:00",
      "source": "paper-chain"
    }
  },
  "ref_id": "REF1693284791uZVQR"
}

QRIS

{
  "additional_info": null,
  "message": "transaction succeed",
  "payment_date": "2023-08-29",
  "payment_info": {
    "channel": "qris",
    "event": "qr.payment",
    "method": "qris",
    "ewallet": {
      "amount": 100000,
      "created": "2023-08-29T12:15:40.397707662+07:00",
      "paid_amount": 100000,
      "paid_at": "2023-08-29T12:16:15.633467823+07:00",
      "status": "PAID",
      "updated": "2023-08-29T12:16:15.633467823+07:00",
      "source": "paper-chain"
    }
  },
  "ref_id": "REF1693286139cxCtu"
}