---
title: "Cancel a claim code"
method: POST
path: "/v1.2/transfers/confirm/{transferId}"
tags: ["Transfer"]
---

# Cancel a claim code

`POST /v1.2/transfers/confirm/{transferId}`

Cancels a Cash Pickup claim code.

## Path parameters

- `transferId` string, required

## Headers

- `requestid` string, required
- `endusersecurityid` string
- `enduserip` string, required
- `partneridentifier` string
- `Authorization` string, required
- `apikey` string

## Request body

- TransferConfirmRequestV11 — TransferConfirmRequestV11
  - `transaction` ConfirmTransactionV11 — ConfirmTransactionV11
    - `claimcode` string — ClaimCode
    - `amount` number, double — Transaction Amount
    - `status` string — Status
    - `storenumber` string — StoreNumber
    - `actiontype` string — Action Type
  - `recipient` ConfirmRecipient — ConfirmRecipient
    - `firstname` string — RecipientFirstName, use by cash profile
    - `lastname` string — RecipientLastName, use by cash profile
    - `streetaddress` string — RecipientAddress, use by cash profile
    - `city` string — RecipientCity, use by cash profile
    - `state` string — RecipientState, use by cash profile
    - `zipcode` string — RecipientZipCode, use by cash profile
    - `dateofbirth` string — RecipientDateOfBirth, use by cash profile
    - `socialsecuritynumber` string — RecipientSocialSecurityNumber, use by cash profile
    - `identificationid` string — RecipientIdentificationId, use by cash profile
    - `identificationtype` string — RecipientIdentificationType, use by cash profile
    - `identificationissuedby` string — RecipientIdentificationIssuedBy, use by cash profile
    - `identificationexpirationdate` string — RecipientIdentificationExpirationDate, use by cash profile

## Response `200`

OK

- TransferConfirmResponseV11 — TransferConfirmResponseV11
  - `transferid` string — TransferId
  - `status` string — Status
  - `changedate` string, date-time — ChangedDate
  - `claimcode` string — ClaimCode
  - `claimcodeexpirationdate` string, date-time — ClaimExpirationDate
  - `customerfee` number, double — CustomerFee
  - `retailcommission` number, double — RetailCommission
  - `partnername` string — PartnerName
  - `receipttext` string — ReceiptText
  - `responsecode` integer — Specifies the status of a Disbursement Core Service Service operation
  - `responsemessage` string — Specifies the descriptive text on the status of a Disbursement Core Service operation
  - `responsedate` string, date-time — RespnseDate
  - `responsedetail` TransferApiResponseDetail — TransferApiResponseDetail
    - `responsedetailcode` integer — ResponseDetailCode
    - `responsedetaildescription` string — ResponseDetailDescription

---

[API](https://skmtc.net/greendot/apis/baas-apis.md) · [All operations](https://skmtc.net/greendot/apis/baas-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/greendot/baas-apis/revisions/666553766b78/schema)
