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

{
  "payment": {
    "id": "PWC_4nn21zy6t0v2yhqg5bvhk7xkq",
    "amount": 1500,
    "net_amount": 1000,
    "captured_amount": 1000,
    "voided_amount": 0,
    "refunded_amount": 100,
    "currency": "USD",
    "customer_id": "CST_AQmxh4y_QGoNNIG5NUw0jttqyYedL1LklACQdyJ3H-Vs6WmLtP6A_C7XjQNohvY",
    "merchant_id": "MMI_4vxs5egfk7hmta3qx2h6rp91x",
    "grant_id": "GRG_221243dc6985a6819ff6950c1a21332f7bc4a46ebd49b5a7002908ab768e8e5ff7831e084d0d2c9d8d939793b55eff50",
    "status": "AUTHORIZED",
    "created_at": "2022-01-01T12:00:00Z",
    "updated_at": "2022-01-05T12:00:00Z",
    "capture_before": "2022-01-08T12:00:00Z",
    "refund_ids": [
      "PWCR_da1v3j4p3z15y47adpzzq0whj"
    ],
    "reference_id": "external-id",
    "metadata": {
      "key": "value"
    },
    "enrichments": {
      "initiation": {
        "actor": "CUSTOMER"
      },
      "recurring_series_id": "string",
      "statement_descriptor": "statement_descriptor",
      "restricted_categories": [
        "ALCOHOL"
      ]
    },
    "decline_errors": [
      {
        "category": "INVALID_REQUEST_ERROR",
        "code": "MISSING_REQUIRED_FIELD",
        "detail": "Missing required parameter.",
        "field": "field_a[2].field_b"
      }
    ],
    "fee_amount": 1.1,
    "fee_rate": {
      "basis_points": 160,
      "fixed_amount": 20
    },
    "authorization_updates": [
      {
        "id": "id",
        "amount": 1,
        "currency": "USD",
        "status": "AUTHORIZED",
        "created_at": "2024-01-15T09:30:00Z",
        "payment_id": "payment_id",
        "previous_amount": 1,
        "metadata": {
          "my-meta": "meta-value"
        },
        "decline_errors": [
          {
            "category": "INVALID_REQUEST_ERROR",
            "code": "MISSING_REQUIRED_FIELD",
            "detail": "Missing required parameter.",
            "field": "field_a[2].field_b"
          }
        ]
      }
    ]
  }
}

Moves an authorized payment to the voided state and releases the payment authorization from the customer’s Cash App account.

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.

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

Request

This endpoint expects an object.

idempotency_keystringRequired1-64 characters

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

Response

paymentobject

Errors

400

Void Payment by Idempotency Key Request Bad Request Error

Headers

Request

Response

Errors