Field NameData TypeDescription
idstringUnique identifier for the object.
typestringThe resource type of the return object. The value is "charge".
statusstringStatus of the charge(payment).
pending - Payment is initiated
authorized - Authorized and ready to capture
expired - Self-explanatory
canceled - Self-explanatory
failed - Payment is failed
succeeded - Payment is successfully captured.
amount_subunitintegerAmount intended to be collected by this payment. A positive integer representing how much to charge in the smallest currency unit.
captured_amount_subunitintegerAmount in cents captured (can be less than the amount attribute on the charge if a partial capture was made).
refunded_amount_subunitintegerAmount in cents refunded (can be less than the amount attribute on the charge if a partial refund was issued).
currencystringThree-letter ISO currency code, in lowercase. Must be a supported currency.
metadatahashSet of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

gateway_metadata is reserved keyword used by Elements, original request metadata contains "gateway_metadata" will be rejected
descriptionstringAn arbitrary string attached to the object. Often useful for displaying to users.
capturedbooleanWhether the charge has been captured.
refundedbooleanWhether the charge has been refunded.
disputedbooleanWhether the charge has been disputed.
refundslistA list of refunds that have been applied to the charge. With few children fields:
refunds.object -
string, value is "list":
String representing the object’s type. Objects of the same type share the same value. Always has the value list. - array of hashes:
Details about each object.

refunds.has_more - Boolean:
True if this list has another page of items after this one that can be fetched.

refunds.url - String:
The URL where this list can be accessed.
disputehashA Dispute Object associated with this charge.
created_atintegerA timestamp indicates when the charge is created
reference_idstringthe payment reference id from PSP.
external_customer_idstringexternal customer id from merchant associated with this charge