Retrieve Charges

Get Charge

Returns the charge identified by the charge key.

Requires charges:Get permission.

get/charges/{chargeKey}

Request

Path parameters

chargeKeystring required

Uniquely identifies a charge.

Example:chg-1e1dAHhgstYTUhlphPzZ

Uniquely identifies a charge.

Response

The charge

OR
OR
OR
OR
OR
OR
OR
OR

Example response

{
  "key": "chg-1e1dAHhgstYTUhlphPzZ",
  "refundedChargeKey": "chg-1e1dAHhgstYTUhlphPzZ",
  "merchantAcceptorRef": {
    "key": "mac-1eOdAHhgstYTUhlphPFf",
    "version": 1
  },
  "tokenDetails": {
    "eci": "05"
  },
  "amount": {
    "value": 2599,
    "currency": "EUR"
  },
  "cardholderBillingAmount": {
    "value": 2599,
    "currency": "EUR"
  },
  "type": {
    "cardEntry": "e-commerce"
  },
  "status": {
    "authentication": "authenticated",
    "authorization": "approved",
    "clearing": "pending"
  },
  "authentication": {
    "sca": {
      "result": {
        "directoryServerTransId": "5340af8a-5505-4bf6-abcd-123412341234"
      }
    }
  },
  "transactionReference": "Dz3dIzE74EfH1HeTInyE",
  "authorizationIsoFields": {
    "responseCode": "00",
    "responseCodeDescription": "Approved",
    "authorizationCode": "4A4316",
    "systemTraceAuditNumber": "123456",
    "retrievalReferenceNumber": "131608123456",
    "networkSpecificFields": {
      "cvcResult": "Y",
      "avsResult": "Y"
    }
  },
  "billingAddress": {
    "countryCode": {
      "alpha3": "NLD",
      "alpha2": "NL",
      "numeric": "528"
    },
    "stateOrProvince": "NH",
    "city": "Amsterdam",
    "line1": "Langtown Road",
    "line2": "4200",
    "postalCode": "1234BC"
  },
  "shippingAddress": {
    "countryCode": {
      "alpha3": "NLD",
      "alpha2": "NL",
      "numeric": "528"
    },
    "stateOrProvince": "NH",
    "city": "Amsterdam",
    "line1": "Langtown Road",
    "line2": "4200",
    "postalCode": "1234BC"
  },
  "dynamicDescriptor": {
    "merchantName": "Acme Inc.",
    "merchantCity": "Amsterdam"
  },
  "foreignRetailer": {
    "amount": 1000
  },
  "subMerchant": {
    "id": "SUB123456",
    "address": {
      "countryCode": {
        "alpha3": "NLD",
        "alpha2": "NL",
        "numeric": "528"
      },
      "stateOrProvince": "NH",
      "city": "Amsterdam",
      "line1": "Langtown Road",
      "line2": "4200",
      "postalCode": "1234BC"
    }
  },
  "version": 1
}

Changes

No recorded changes to this operation across all 1 revision of this API.