Get Charge

gethttps://api.nomod.com/v1/charges/{id}

Retrieve Charge by ID.

curl -X GET 'https://api.nomod.com/v1/charges/:id' \
  -H 'X-API-KEY: $NOMOD_API_KEY' \
  -H 'Content-Type: application/json'

Path parameters

idstring <uuid>required

Responses

idstring <uuid>requiredread-only

reference_idintegerrequiredread-only

createdstring <date-time>requiredread-only

taxesarray

itemsarrayrequired

currencystringrequired

discountstring <decimal>requiredread-only

service_feestring <decimal>

statusobjectrequiredread-only

tipstring <decimal>requiredread-only

taxstring <decimal>requiredread-only

totalstring <decimal>requiredread-only

refund_totalstring <decimal>requiredread-only

notestringrequiredread-only

payment_methodobjectrequiredread-only

discount_percentagestring <decimal>

service_fee_percentagestring <decimal>

tip_percentagestring <decimal>

userobjectrequired

sourceobject

view_countintegerrequiredread-only

errorstringrequiredread-only

custom_fieldsarray

refundsarrayrequiredread-only

service_fee_dataany

payment_capture_sourcestring

eventsobjectrequiredread-only

settlement_currencystringrequired

feenumberrequiredread-only

fx_feenumberrequiredread-only

fee_taxstring <decimal>requiredread-only

netnumberrequiredread-only

network_coststring <decimal>requiredread-only

success_urlstringrequiredread-only

failure_urlstringrequiredread-only

Example response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "reference_id": 0,
  "created": "2026-01-01T00:00:00Z",
  "taxes": [
    0
  ],
  "items": [
    {
      "amount": "0.00",
      "name": "string",
      "total_amount": "0.00",
      "quantity": 0,
      "product": "00000000-0000-0000-0000-000000000000",
      "sku": "string"
    }
  ],
  "currency": "string",
  "discount": "0.00",
  "service_fee": "0.00",
  "status": {
    "0": "a",
    "1": "u",
    "2": "t",
    "3": "h",
    "4": "o",
    "5": "r",
    "6": "i",
    "7": "s",
    "8": "e",
    "9": "d"
  },
  "tip": "0.00",
  "tax": "0.00",
  "total": "0.00",
  "refund_total": "0.00",
  "note": "string",
  "payment_method": {
    "0": "c",
    "1": "a",
    "2": "s",
    "3": "h"
  },
  "discount_percentage": "0.00",
  "service_fee_percentage": "0.00",
  "tip_percentage": "0.00",
  "user": {
    "id": "00000000-0000-0000-0000-000000000000",
    "first_name": "string",
    "last_name": "string"
  },
  "source": {
    "type": "string",
    "token": "string",
    "expiry_month": "string",
    "expiry_year": "string",
    "name": "string",
    "scheme": "string",
    "scheme_local": "string",
    "last4": "string",
    "bin": "string",
    "card_type": "string",
    "card_category": "string",
    "issuer": "string",
    "issuer_country": "string",
    "product_id": "string",
    "product_type": "string",
    "expires_on": "string",
    "card_data": {
      "card_number": "string",
      "expiry_month": "string",
      "expiry_year": "string",
      "security_code": "string",
      "card_holder_name": "string"
    },
    "card_holder_name": "string"
  },
  "view_count": 0,
  "error": "string",
  "custom_fields": [],
  "refunds": [
    {
      "created": "2026-01-01T00:00:00Z",
      "amount": "0.00"
    }
  ],
  "service_fee_data": null,
  "payment_capture_source": "string",
  "events": {
    "created": "2026-01-01T00:00:00Z",
    "type": {
      "0": "a",
      "1": "u",
      "2": "t",
      "3": "h",
      "4": "o",
      "5": "r",
      "6": "i",
      "7": "s",
      "8": "e",
      "9": "d"
    },
    "message": "string",
    "user": {
      "id": "00000000-0000-0000-0000-000000000000",
      "first_name": "string",
      "last_name": "string"
    }
  },
  "settlement_currency": "string",
  "fee": 0,
  "fx_fee": 0,
  "fee_tax": "0.00",
  "net": 0,
  "network_cost": "0.00",
  "success_url": "string",
  "failure_url": "string"
}