HSRCPAY Dökümantasyon
API v1

Get charge

Returns one charge by id, including amount and provider linkage when authorized. Requires `account:charge:read` on the owning account.

GET
/charges/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

Use Authorization: Bearer <token>. The same header supports: (1) JWT access token from the configured auth provider; (2) secret API key whose value contains sk_ within the first 32 characters (e.g. sk_live_…, sk_test_…); (3) publishable key containing pk_. Sandbox keys typically include _test_ in the string; the server resolves repositories from that.

In: header

Path Parameters

id*Charge ID

Charge identifier to retrieve.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.hsrcpay.com/v1/charges/string"
{
  "message": "success",
  "success": true,
  "data": {
    "object": "charge",
    "id": "string",
    "payment_id": "string",
    "payment_method_id": "string",
    "customer_id": "string",
    "account_id": "string",
    "status": "CREATED",
    "amount": 0,
    "authorized_amount": 0,
    "captured_amount": 0,
    "refunded_amount": 0,
    "currency": "USD",
    "installments": 0,
    "security": {
      "property1": null,
      "property2": null
    },
    "transaction": {
      "property1": null,
      "property2": null
    },
    "exchanges": [
      null
    ],
    "details": {
      "property1": null,
      "property2": null
    },
    "performance": {
      "duration": 0,
      "property1": null,
      "property2": null
    },
    "metadata": {
      "property1": null,
      "property2": null
    },
    "routing_plan_id": "string",
    "routing_origin": "MERCHANT_DIRECT",
    "attempt_no": 0,
    "payment_provider_id": "string",
    "payment_provider_method_id": "string",
    "payment_provider_config_snapshot": {
      "property1": null,
      "property2": null
    },
    "created_at": null,
    "updated_at": null,
    "property1": null,
    "property2": null
  },
  "property1": null,
  "property2": null
}
{
  "message": "string",
  "success": false,
  "error": {
    "code": 0,
    "message": "string",
    "details": {
      "property1": null,
      "property2": null
    },
    "property1": null,
    "property2": null
  },
  "property1": null,
  "property2": null
}
{
  "message": "string",
  "success": false,
  "error": {
    "code": 0,
    "message": "string",
    "details": {
      "property1": null,
      "property2": null
    },
    "property1": null,
    "property2": null
  },
  "property1": null,
  "property2": null
}
{
  "message": "string",
  "success": false,
  "error": {
    "code": 0,
    "message": "string",
    "details": {
      "property1": null,
      "property2": null
    },
    "property1": null,
    "property2": null
  },
  "property1": null,
  "property2": null
}
{
  "message": "string",
  "success": false,
  "error": {
    "code": 0,
    "message": "string",
    "details": {
      "property1": null,
      "property2": null
    },
    "property1": null,
    "property2": null
  },
  "property1": null,
  "property2": null
}
{
  "message": "string",
  "success": false,
  "error": {
    "code": 0,
    "message": "string",
    "details": {
      "property1": null,
      "property2": null
    },
    "property1": null,
    "property2": null
  },
  "property1": null,
  "property2": null
}
{
  "message": "string",
  "success": false,
  "error": {
    "code": 0,
    "message": "string",
    "details": {
      "property1": null,
      "property2": null
    },
    "property1": null,
    "property2": null
  },
  "property1": null,
  "property2": null
}
{
  "message": "string",
  "success": false,
  "error": {
    "code": 0,
    "message": "string",
    "details": {
      "property1": null,
      "property2": null
    },
    "property1": null,
    "property2": null
  },
  "property1": null,
  "property2": null
}
{
  "message": "string",
  "success": false,
  "error": {
    "code": 0,
    "message": "string",
    "details": {
      "property1": null,
      "property2": null
    },
    "property1": null,
    "property2": null
  },
  "property1": null,
  "property2": null
}