The charge object

Attributes

Field Name

Data Type

Description

id

string

Unique identifier for the object.

type

string

The resource type of the return object. The value is "charge".

status

string

Status 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_subunit

integer

Amount intended to be collected by this payment. A positive integer representing how much to charge in the smallest currency unit.

captured_amount_subunit

integer

Amount in cents captured (can be less than the amount attribute on the charge if a partial capture was made).

refunded_amount_subunit

integer

Amount in cents refunded (can be less than the amount attribute on the charge if a partial refund was issued).

currency

string

Three-letter ISO currency code, in lowercase. Must be a supported currency.

metadata

hash

Set 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

description

string

An arbitrary string attached to the object. Often useful for displaying to users.

captured

boolean

Whether the charge has been captured.

refunded

boolean

Whether the charge has been refunded.

disputed

boolean

Whether the charge has been disputed.

refunds

list

A 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.

refunds.data - 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.

dispute

hash

A Dispute Object associated with this charge.

created_at

integer

A timestamp indicates when the charge is created

reference_id

string

the payment reference id from PSP.

external_customer_id

string

external customer id from merchant associated with this charge