Void payment by idempotency key

Moves an authorized payment to the voided state and releases the payment authorization from the customer's Cash App account. <Note title="Note"> You can only void an authorized payment. If a payment is captured, refund the payment instead. You cannot void any payment that has had an attempted capture. Authorizations not captured within seven days are automatically voided. </Note> This endpoint will return a success message if the payment was successfully voided _or_ if the payment was previously voided. **This endpoint is not rate limited.** Scopes: `PAYMENTS_WRITE`

Headers

AcceptstringRequired
X-RegionstringRequired
X-SignaturestringRequired
User-AgentstringRequired

Request

This endpoint expects an object.
idempotency_keystringRequired>=1 character<=64 characters

Idempotency key used in the create payment request for the payment you want to void.

Response

OK
paymentobject

Errors