Void refund by idempotency key | Welcome to cash-app Documentation

Moves an authorized refund to the voided state using the idempotency key specified while creating the refund.

<Note> You can only void an authorized refund. If a refund is captured, there is no way to reverse it. </Note>

In rare cases, an issue with an integration, network connectivity, or the Cash App Pay API may cause an API client to end up in a state where a refund is created in Cash App Pay, but the API client doesn’t know the ID of the refund. This endpoint allows an API client to void a refund using only the idempotency key to recover from these situations.

If you don’t have the idempotency key or ID of the refund you want to void, you can use the list refunds endpoint to try to search for the refund you’re looking for.

This endpoint is not rate limited.

Scopes: REFUNDS_WRITE

Moves an authorized refund to the voided state using the idempotency key specified while creating the refund. <Note> You can only void an authorized refund. If a refund is captured, there is no way to reverse it. </Note> In rare cases, an issue with an integration, network connectivity, or the Cash App Pay API may cause an API client to end up in a state where a refund is created in Cash App Pay, but the API client doesn't know the ID of the refund. This endpoint allows an API client to void a refund using _only_ the idempotency key to recover from these situations. If you don't have the idempotency key or ID of the refund you want to void, you can use the [list refunds](Network-API.v1.yaml/paths/~1refunds/get) endpoint to try to search for the refund you're looking for. **This endpoint is not rate limited.** Scopes: `REFUNDS_WRITE`

Request

This endpoint expects an object.

idempotency_keystringRequired>=1 character<=64 characters

A unique identifier which can be used by Cash App to de-duplicate retries of this request, making it idempotent. Learn more about idempotency in the API.

Response

refundobject

Errors