---
title: "Request payment cancellation"
method: POST
path: "/api/v1/member/{memberId}/payments/{paymentId}/cancel"
tags: ["MemberPayments"]
---

# Request payment cancellation

`POST /api/v1/member/{memberId}/payments/{paymentId}/cancel`

## Request

- Base URL: `http://api.redcard.com`
- URL: `http://api.redcard.com/api/v1/member/{memberId}/payments/{paymentId}/cancel`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/redcard/apis/ccp-docs-wcf-public/docs/api/v1/member/:memberId/payments/:paymentId/cancel/post.ts> (a function with typed inputs; its response is checked against the schema)

A payment can only be canceled before we have transfered the funds to the provider.
You can request a payment cancellation at any time, but if we have already paid the provider this call will return an error with status code 409 (conflict).

## Path parameters

- `memberId` string, uuid, required
- `paymentId` string, uuid, required

## Response `200`

Payment Canceled

- CcpDocsWcfMemberPayment: Status of Member Submitted Payment
  - `Id` string, uuid: Unique Payment ID
  - `ConfirmationNumber` string: Payment Confirmation Number
  - `AmountPaid` number, double: Payment Amount
  - `ErrorMessage` string: Error Message
  - `Status` string: Payment Status PendingProcessing ProcessingPayment AdditionalInfoRequired DrawdownFailure Paid Canceled
  - `SubmittedDate` string, date-time: Payment Submitted Date
  - `BillId` string, uuid: Unique identifier for the bill the payment relates to
  - `FundingMethod` string: Payment funding method Stripe (card, native wallet) BankAccount

## Other responses

- `400`: Invalid request parameters
- `401`: Invalid credentials
- `403`: Invalid permissions
- `404`: Requested resource does not exist
- `409`: Payment not in a valid state for cancellation
- `500`: Unexpected error, contact Zelis

---

[API](https://skmtc.dev/redcard/apis/ccp-docs-wcf-public.md) - [All operations](https://skmtc.dev/redcard/apis/ccp-docs-wcf-public/llms.txt) - [OpenAPI document](https://skmtc.dev/redcard/apis/ccp-docs-wcf-public/revisions/b572c437ad6b?raw)