PostChargesResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/credorax/main/json-schema/credorax-post-charges-response-schema.json",
  "title": "PostChargesResponse",
  "x-generated": "2026-10-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/_ae-authored/credorax-openapi-generated.yml#/components/schemas/PostChargesResponse",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the charge."
    },
    "created": {
      "type": "integer",
      "description": "Unix timestamp (seconds) when the charge was created."
    },
    "objectType": {
      "type": "string",
      "description": "Object type identifier."
    },
    "amount": {
      "type": "integer",
      "description": "Charge amount in the smallest currency unit."
    },
    "amountRefunded": {
      "type": "integer",
      "description": "Amount refunded so far, in the smallest currency unit."
    },
    "currency": {
      "type": "string",
      "description": "Three-letter ISO 4217 currency code."
    },
    "description": {
      "type": "string",
      "description": "Optional description of the charge."
    },
    "type": {
      "type": "string",
      "description": "Stored-credential indicator sent to the card network."
    },
    "status": {
      "type": "string",
      "description": "Current status of the charge."
    },
    "captured": {
      "type": "boolean",
      "description": "Whether the charge has been captured."
    },
    "refunded": {
      "type": "boolean",
      "description": "Whether the charge has been fully refunded."
    },
    "refunds": {
      "type": "array",
      "description": "List of refunds issued against this charge."
    },
    "disputed": {
      "type": "boolean",
      "description": "Whether the charge is currently disputed."
    },
    "dispute": {
      "type": "object",
      "description": "The dispute object, present when the charge has been disputed."
    },
    "flow": {
      "type": "object",
      "description": "Details of the payment process for payment methods that require additional customer action."
    },
    "customerId": {
      "type": "string",
      "description": "ID of the customer associated with this charge."
    },
    "subscriptionId": {
      "type": "string",
      "description": "ID of the subscription that generated this charge, if any."
    },
    "clientObjectId": {
      "type": "string",
      "description": "Client-facing identifier that can be used with shift4.js to check the charge status from the browser."
    },
    "options": {
      "type": "object",
      "description": "Authorization options for the charge."
    },
    "metadata": {
      "type": "object",
      "description": "Set of key-value pairs for storing additional information."
    },
    "fraudDetails": {
      "type": "object",
      "description": "Fraud detection details."
    },
    "arn": {
      "type": "string",
      "description": "Acquirer Reference Number assigned to the settled transaction."
    },
    "schemeTransactionId": {
      "type": "string",
      "description": "Identifier of the transaction in the card scheme's network."
    },
    "paymentAccountReference": {
      "type": "string",
      "description": "Payment Account Reference (PAR)."
    },
    "aft": {
      "type": "object",
      "description": "Account Funding Transaction details."
    },
    "authCode": {
      "type": "string",
      "description": "Authorization code returned by the issuer."
    },
    "threeDSecureInfo": {
      "type": "object",
      "description": "3D Secure verification details."
    },
    "avsCheck": {
      "type": "object",
      "description": "Address Verification Service result."
    },
    "aniCheck": {
      "type": "object",
      "description": "Account Name Inquiry result (Visa)."
    },
    "cvvCheck": {
      "type": "object",
      "description": "CVV/CVC verification result."
    },
    "failureCode": {
      "type": "string",
      "description": "Error code describing why the charge failed."
    },
    "failureMessage": {
      "type": "string",
      "description": "Human-readable message describing why the charge failed."
    },
    "failureIssuerDeclineCode": {
      "type": "string",
      "description": "Decline code supplied by the card issuer."
    },
    "adviceCode": {
      "type": "string",
      "description": "Advice on how to proceed with a declined charge."
    },
    "networkAdviceCode": {
      "type": "string",
      "description": "Raw advice code received from the issuer or card network."
    },
    "collectionMode": {
      "type": "string",
      "description": "How the order was collected for this charge."
    },
    "billing": {
      "type": "object",
      "description": "Billing details for the payer."
    },
    "shipping": {
      "type": "object",
      "description": "Shipping details for the order."
    },
    "external": {
      "type": "object",
      "description": "External references attached to the charge."
    },
    "multibanco": {
      "type": "object",
      "description": "Additional information for Multibanco payments."
    },
    "splits": {
      "type": "array",
      "description": "List of charge splits."
    },
    "merchantAccountId": {
      "type": "string",
      "description": "Identifier of the merchant account used to process this charge."
    },
    "card": {
      "type": "object",
      "description": "The card used for this charge."
    }
  }
}