JUjustifi
Payments
Voids

Void a Payment

Void an ecom card or ACH payment transaction to cancel the payment before it reaches settlement. Payment transactions are voidable within 25 minutes of the original transaction. This includes authorized payments (that were created with capture_strategy manual and have not been captured yet).

post/payments/{id}/void

Request

Path parameters

idstring uuid required

Headers

Idempotency-Keystring uuid required

a string to identify your request (we recommend using a generated uuid, but you may use any unique string) see Idempotent Requests

Authorizationstring required

the access_token value returned from the JustiFi oauth/token endpoint (be sure to append Bearer before the token)

Response

Payment was voided successfully

idstring uuid

the object id, also found in the data object

typestring

the object type, or array of objects

page_infounknown

Example response

{
  "id": "prefix_xyz (same as id of data object)",
  "type": "account",
  "data": {
    "id": "py_xyz",
    "account_id": "acc_xyz",
    "amount": 10000,
    "amount_refundable": 10000,
    "balance": 99850,
    "fee_amount": 150,
    "financial_transaction_id": "ft_123xyz",
    "captured": true,
    "capture_strategy": "automatic",
    "currency": "usd",
    "description": "my_order_xyz",
    "disputes": [],
    "error_code": "credit_card_number_invalid",
    "error_description": "Credit Card Number Invalid (Failed LUHN checksum)",
    "is_test": true,
    "metadata": {},
    "payment_intent_id": "pi_123xyz",
    "checkout_id": "cho_123xyz",
    "payment_method": {
      "card": {
        "id": "pm_123xyz",
        "brand": "Visa",
        "digital_wallet": "apple_pay",
        "name": "Amanda Kessel",
        "token": "pm_123xyz",
        "month": "5",
        "year": "2042",
        "metadata": {},
        "created_at": "2021-01-01T12:00:00Z",
        "updated_at": "2021-01-01T12:00:00Z",
        "address_line1_check": "unchecked",
        "address_postal_code_check": "unchecked"
      },
      "customer_id": "cust_xyz",
      "signature": "4guAJNkVA3lRLVlanNVoBK",
      "account_id": "acc_123"
    },
    "application_fee": {
      "id": "fee_123xyz",
      "amount": 150,
      "currency": "usd",
      "created_at": "2021-01-01T12:00:00Z",
      "updated_at": "2021-01-01T12:00:00Z"
    },
    "application_fee_rate_id": "afr_123xyz",
    "fees": [
      {
        "id": "pyfee_abc",
        "type": "processing_fee",
        "amount": 350,
        "currency": "usd",
        "remaining_amount": 350,
        "source_configuration_id": "sfc_abc123",
        "source_fee_type": "processing_ecomm",
        "refund_id": null
      },
      {
        "id": "pyfee_xyz",
        "type": "platform_fee",
        "amount": 500,
        "currency": "usd",
        "remaining_amount": 500,
        "source_configuration_id": "sfc_abc123",
        "source_fee_type": "platform",
        "refund_id": null
      }
    ],
    "payment_mode": "ecom",
    "terminal_id": "trm_123xyz",
    "transaction_hold": {
      "id": "th_123xyz",
      "financial_transaction_id": "ft_123xyz"
    },
    "created_at": "2021-01-01T12:00:00Z",
    "updated_at": "2021-01-01T12:00:00Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.