---
title: "Cancel a payment"
method: POST
path: "/payments/{payment_id}/cancel"
tags: ["Payments"]
---

# Cancel a payment

`POST /payments/{payment_id}/cancel`

## Request

- Base URL: `https://production.pier-finance.com/api`
- URL: `https://production.pier-finance.com/api/payments/{payment_id}/cancel`
- Auth: HTTP bearer

Cancels a submitted payment before it is sent to the ACH network. Payments can only be canceled if they are still in the `pending` state and have not been submitted to the ACH network. After a payment is sent to the ACH network, you must wait for the it to settle and then you may refund it instead.
  
In some cases if you cancel while the payment is in the process of being submitted to the ACH network you may see a status of `cancellation_pending` in the response. In this case, you can check the status of the payment or wait for a subsequent webhook to see if it was successfully canceled or processed.

## Path parameters

- `payment_id` string, required

## Response `200`

- Payment
  - `id` string, required
  - `amount` integer, required: The amount of the payment, in cents
  - `facility_id` string, required: The facility_id of the credit facility to make a payment for
  - `status` 'pending' | 'processing' | 'processed' | 'settled' | 'failed' | 'canceled' | 'cancellation_pending', required
  - `transfer_type` 'standard' | 'none' | 'refund' | 'credit' | 'cancellation' | 'suspense_credit', required: Transfer types that are not standard/none are set by special operations like the refund endpoint for example. Special types, like refund, will reference the original transaction transfer type of standard/none to determine if ACH was used if this knowledge is needed (e.g. does an ACH refund need to happen or was this ledgering only).
  - `created_on` string, date-time, required: Timestamp the payment is created on
  - `failure_reason` string, nullable: A reason for the failure if one exists
  - `is_autopay` boolean, nullable: If the payment was a result of an autopay

## Other responses

- `400`
- `401`
- `404`
- `409`
- `429`
- `500`

---

[API](https://skmtc.dev/pier-finance/apis/pier-api.md) - [All operations](https://skmtc.dev/pier-finance/apis/pier-api/llms.txt) - [OpenAPI document](https://skmtc.dev/pier-finance/apis/pier-api/revisions/08a7c49252b9?raw)