Charges

Retrieve charges created from charge intents. A charge is the settled record of a successful payment.

ENDPOINTS

GET/v1/charges/{id}GET/v1/charges/{id}/trace

The Charge object

Attributes

idstring

Unique identifier for the charge

objectstring

Object type identifier. Always charge.

amountinteger

Amount charged in cents

currencystring

Three-letter ISO currency code

statusstring

Charge status. One of pending, succeeded, or failed.

livemodeboolean

true if live mode, false if test mode

createdinteger

Unix timestamp of creation

charge_intent_idnullable string

ID of the charge intent that created this charge

THE CHARGE OBJECT

{
  "id": "b72fce52-eb12-5704-91a4-e3da890fb648",
  "object": "charge",
  "amount": 2000,
  "currency": "usd",
  "status": "succeeded",
  "livemode": false,
  "created": 1721010605,
  "charge_intent_id": "a70cd72f-e74a-40f2-96a2-3f60714aac4a"
}

Get charge

Retrieve a charge by ID

Path parameters

idstringrequired

Charge ID

Returns

Successful response

GET/v1/charges/{id}

curl --request GET \
  --url https://api.framepayments.com/v1/charges/a70cd72f-e74a-40f2-96a2-3f60714aac4a \
  --header 'Authorization: Bearer API_KEY'

RESPONSE

{
  "id": "06967363-ea08-4a6b-b6e5-4864c96c45c8",
  "currency": "usd",
  "failure_code": null,
  "failure_message": null,
  "failure_category": null,
  "description": null,
  "status": "succeeded",
  "acquirer_reference_number": null,
  "authorization_code": null,
  "object": "charge",
  "payment_method_details": {
    "id": "4e4f2d48-ef09-4006-a8c7-f58ed406d238",
    "customer_id": null,
    "account_id": null,
    "billing": {
      "id": "0d5a39cd-c5ef-4d1b-8272-e776585d90bc",
      "city": "Port Noahside",
      "country": "US",
      "state": "CA",
      "postal_code": "82654",
      "line_1": "4971 Billy Shoal",
      "line_2": "Suite 383",
      "livemode": false,
      "type": "billing"
    },
    "type": "card",
    "object": "payment_method",
    "created": 1781115871,
    "updated": 1781115871,
    "livemode": false,
    "status": "active",
    "card": {
      "brand": "visa",
      "exp_month": "09",
      "exp_year": "31",
      "issuer": null,
      "currency": null,
      "segment": null,
      "type": null,
      "last_four": "4242"
    }
  },
  "customer": "1e934470-3625-453a-86b7-2ad004a37a1c",
  "account": null,
  "account_id": null,
  "payment_method": "4e4f2d48-ef09-4006-a8c7-f58ed406d238",
  "amount": 1000,
  "amount_captured": 0,
  "amount_refunded": 0,
  "created": 1781115871,
  "updated": 1781115871,
  "livemode": false,
  "captured": true,
  "disputed": false,
  "charge_intent": "94264705-6e7a-43ce-874b-36b5c494576d",
  "refunded": false,
  "net_amount": 926
}

Get charge trace

Retrieve a charge with ledger/trace information

Path parameters

idstringrequired

Charge ID

Returns

Charge with trace data

GET/v1/charges/{id}/trace

curl --request GET \
  --url https://api.framepayments.com/v1/charges/a70cd72f-e74a-40f2-96a2-3f60714aac4a/trace \
  --header 'Authorization: Bearer API_KEY'

RESPONSE

{
  "id": "c66bbb93-09ab-44ca-be96-60244159b1fd",
  "currency": "usd",
  "failure_code": null,
  "failure_message": null,
  "failure_category": null,
  "description": null,
  "status": "succeeded",
  "acquirer_reference_number": null,
  "authorization_code": null,
  "object": "charge",
  "payment_method_details": {
    "id": "f643d3de-1b1b-4e89-9ed8-d9fd7254ecc1",
    "customer_id": null,
    "account_id": null,
    "billing": {
      "id": "0c02ea84-6027-4aad-be2c-e8353662d5da",
      "city": "Lake Guston",
      "country": "US",
      "state": "CA",
      "postal_code": "79617",
      "line_1": "3232 Stoltenberg Pike",
      "line_2": "Suite 942",
      "livemode": false,
      "type": "billing"
    },
    "type": "card",
    "object": "payment_method",
    "created": 1781115871,
    "updated": 1781115871,
    "livemode": false,
    "status": "active",
    "card": {
      "brand": "visa",
      "exp_month": "07",
      "exp_year": "31",
      "issuer": null,
      "currency": null,
      "segment": null,
      "type": null,
      "last_four": "4242"
    }
  },
  "customer": "2e7ac76e-cbd1-4335-ad30-ca0bb4079ece",
  "account": null,
  "account_id": null,
  "payment_method": "f643d3de-1b1b-4e89-9ed8-d9fd7254ecc1",
  "amount": 1000,
  "amount_captured": 0,
  "amount_refunded": 0,
  "created": 1781115871,
  "updated": 1781115871,
  "livemode": false,
  "captured": true,
  "disputed": false,
  "charge_intent": "e41201c1-d8a5-4a15-8463-51956936109f",
  "refunded": false,
  "net_amount": 926,
  "ledger": {
    "journals": []
  }
}