v1

latestOpenAPI 3.0.3Apache 2.02026-08-062991191002.1 KB

Charge

Retrieves a Charge resource.

get/charges/{id}

Path parameters

idstring required

Resource identifier

Response

Charge resource

idstring

integrationstring

The key of the integration source e.g. "quickbooks", or "xero"

srcIdstring

Unique identifier for a charge

amountinteger

The amount charged

amountRefundedinteger nullable

The amount refunded

applicationIdstring nullable

ID of the application that created the charge

applicationFeeAmountinteger nullable

The application fee for the charge

balanceTransactionIdstring nullable

ID of the balance transaction that describes the impact of the charge on the account balance

billingAddressstring nullable

The billing address for the payment

billingEmailstring nullable

The email address associated with the charge

billingNamestring nullable

The full name of the customer the charge is for

billingPhonestring nullable

The phone number of the customer the charge is for

createdstring date-time nullable

The date and time the charge was created

currencystring

The currency the charge was made in

customerIdstring nullable

The ID associated with the customer in which the charge is for

chargeDescriptionstring nullable

A description of the charge

invoiceIdstring nullable

The ID of the invoice this charge is for

receiptNumberstring nullable

The transaction number that appears on email receipts sent for this charge

refundedstring nullable

Whether the charge has been fully refunded

statusstring nullable

The status of the charge e.g. "succeeded" e.g. "pending" e.g. "failed"

shippingAddressstring nullable

The shipping address associated with the charge

shippingNamestring nullable

Recipient name

shippingPhonestring nullable

Recipient phone number

shippingTrackingNumberstring nullable

The tracking number for a physical product, obtained from the delivery service

Example response

{
  "integration": "quickbooks"
}