---
title: "Cancel a payment"
method: DELETE
path: "/v1/charges/{id}/capture"
---

# Cancel a payment

`DELETE /v1/charges/{id}/capture`

## Path parameters

- `id` string, required

## Query parameters

- `custom_fields` object
  - `any_name` string — The custom fields Object allows you to add any key/value pair to the API request to be returned in the response

## Headers

- `x-user-secret-key` string, required
- `Content-Type` string, required

## Response `200`

200

- object
  - `status` integer
  - `error` unknown
  - `resource` object
    - `type` string
    - `data` object
      - `transfer` object
        - `items` object[]
      - `schedule` object
        - `authorised_pended_at` string
        - `stopped` boolean
      - `statistics` object
        - `total_refunded_amount` integer
        - `full_refund` boolean
        - `need_sync` boolean
      - `customer` object
        - `payment_source` object
          - `source_id` string
          - `type` string
          - `ref_token` string
          - `card_name` string
          - `card_number_last4` string
          - `card_number_bin` string
          - `card_scheme` string
          - `card_funding_method` string
          - `expire_month` integer
          - `expire_year` integer
          - `gateway_id` string
          - `gateway_type` string
          - `gateway_name` string
          - `vault_token` string
          - `vault_type` string
          - `items` object[]
        - `customer_id` string
        - `first_name` string
        - `last_name` string
        - `email` string
        - `phone` string
        - `reference` string
      - `_id` string
      - `type` string
      - `amount` integer
      - `currency` string
      - `status` string
      - `company_id` string
      - `capture` boolean
      - `authorization` boolean
      - `archived` boolean
      - `one_off` boolean
      - `_source_ip_address` string
      - `items` object[]
      - `transactions` object[]
        - `created_at` string
        - `type` string
        - `status` string
        - `amount` integer
        - `currency` string
        - `gateway_specific_code` unknown
        - `gateway_specific_description` unknown
        - `error_message` unknown
        - `error_code` unknown
        - `status_code` unknown
        - `status_code_description` unknown
        - `initialization_source` string
        - `_id` string
        - `authorization_code` string
        - `external_id` string
        - `external_reference` string
        - `pended_at` string
        - `processed_at` string
        - `updated_at` string
      - `updated_at` string
      - `created_at` string
      - `__v` integer
      - `external_id` string
      - `logs_migrated` boolean

## Other responses

- `400` — 400

---

[API](https://skmtc.dev/commbank/apis/powerboard-api.md) · [All operations](https://skmtc.dev/commbank/apis/powerboard-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/commbank/powerboard-api/revisions/2ef3ed32f8c2/schema)