The Payment object represents the life cycle of payment from the time it was requested to the completion of it. It is used for accepting one-time payments from customers.


Payment attributes

AttributesTypeDescription
idstringUnique identifier for the object.
statusenumThe status of the payment. See Payment Statuses
amountstringThe payment amount to be received.
createdAttimestampTime at which the object was created.
descriptionstringAn arbitrary string attached to the object. Often useful for displaying to users.
expiredAttimestampTime at which the Payment object should no longer be able to successfully receive any payments.
referenceIdstringThe referenceId that was used to request for the Payment. Typically an "order id", "invoice id" or "cart id".
feesstringThe amount of fees charged to your platform to process this payment.
paymentMethodobjectThe Payment Method to be used to capture the payment.

Refer to Payment Method to understand the Payment Method object.

Payment object

{
  "data": {
    "id": "contract_7abf6bb130d44c02862982ff6022875d",
    "type": "payment",
    "attributes": {
      "status": "paid",
      "amount": "110000.0",
      "createdAt": "2020-08-14T14:35:24+07:00",
      "description": null,
      "expiredAt": null,
      "referenceId": "external_id_b470bc6356",
      "fees": "3630.0",
      "paymentMethod": {
        "type": "virtual_bank_account",
        "referenceId": "va_reference_id",
        "instructions": {
          "bankShortCode": "BNI",
          "accountNo": "8848095778242337",
          "displayName": "Nama Tampilan"
        }
      }
    }
  }
}