v1

latestOpenAPI 3.1.02026-07-24170121.2 MB

Void a Charge

This API voids a charge that was created.

post/v1/charges/{charge_id}/void

Path parameters

charge_idstring required

charge_id here represents a specific charge that should be voided.

Request body

reason'requested_by_customer' | 'fraudulent' | 'duplicate' | 'other' required

Reason for voiding a transaction.

void_descriptionstring

Description for voiding a transaction.

Response

201

Example response

{
  "data": {
    "object": "Charge",
    "id": "DLbnOBbBDWMbbOoM",
    "amount": 99,
    "amount_approved": 99,
    "amount_captured": 500,
    "amount_voided": 500,
    "tip_amount": 20,
    "type": "Sale",
    "customer_email": "eric.yulfo@payarc.com",
    "captured": 1,
    "status": "void",
    "auth_code": "TAS697",
    "statement_description": "Eric's Energy Drinks",
    "created_at": 1725459426,
    "updated_at": 1725461016,
    "card_level": "LEVEL1",
    "created_by": "serviceuser0567051053675152@payarc.com",
    "void_reason": "requested_by_customer",
    "tsys_response_code": "A0000",
    "host_response_code": "00",
    "host_response_message": "Success",
    "host_reference_number": "424814500418",
    "card": {
      "data": {
        "object": "Card",
        "id": "vmy905NNNm5y0M2L",
        "card_source": "PHONE",
        "is_default": 1,
        "exp_month": "12",
        "exp_year": "2025",
        "is_verified": 1,
        "fingerprint": "my905PmvmPNmNP0M",
        "brand": "V",
        "last4digit": "5439",
        "first6digit": 401200,
        "avs_status": "0",
        "cvc_status": "M",
        "customer_id": "4DPNMVjxNPnMVnjA",
        "created_at": 1725451100,
        "updated_at": 1725451161
      }
    }
  },
  "meta": {
    "include": [
      "review"
    ]
  }
}