RevKeen Docs
Api reference

Get charge

Retrieve details of a specific charge.

Related endpoints

  • POST /charges — Create a one-time charge
  • GET /charges — List charges
  • POST /charges/{id}/capture — Capture charge
  • POST /charges/{id}/refund — Refund charge

Common errors

  • 401 unauthenticated — missing, malformed, or revoked API key.
  • 404 resource_missing — the referenced resource does not exist or is not visible to your key.
GET
/charges/{id}

Authorization

x-api-key<token>

Your RevKeen API key (powered by Unkey). Get it from Dashboard > Settings > API Keys. Use rk_sandbox_* for test mode and rk_live_* for production.

In: header

Path Parameters

id*string
Formatuuid

Response Body

application/json

curl "https://api.revkeen.com/v2/charges/00000000-0000-0000-0000-000000000000" \  -H "x-api-key: $REVKEEN_API_KEY"
{
  "data": {
    "id": "string",
    "customerId": "string",
    "invoiceId": "string",
    "paymentMethodId": "string",
    "amountMinor": 0,
    "amountCapturedMinor": 0,
    "amountRefundedMinor": 0,
    "currency": "str",
    "status": "pending",
    "description": "string",
    "statementDescriptor": "string",
    "failureCode": "string",
    "failureMessage": "string",
    "gatewayTransactionId": "string",
    "receiptUrl": "string",
    "captured": true,
    "metadata": {
      "property1": null,
      "property2": null
    },
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}
Empty
Empty
Edit on GitHub