--- title: "PATCH /v1/charges/{charge_id}/overwrite-split" method: PATCH path: "/v1/charges/{charge_id}/overwrite-split" --- # PATCH /v1/charges/{charge_id}/overwrite-split `PATCH /v1/charges/{charge_id}/overwrite-split` ## Path parameters - `charge_id` string, required ## Request body - object - `splits` object[], required — An array of split allocation objects that define how the transaction amount is distributed among multiple merchants or payees. Each split specifies the recipient’s merchant ID (mid) and the percentage of the total transaction (percent) they should receive. - `mid` string, required — The designated merchant or payee receiving the split funds. - `percent` string, required — The percentage of the transaction allocated to the designated payee. Either amount or percent may be provided, but not both. - `amount` string — The amount of the transaction allocated to the designated payee. Either amount or percent may be provided, but not both. ## Response `200` OK - object - `data` object, required — Complete charge object data. - `object` string — Type of object returned (Charge). - `id` string — Unique identifier for the charge. - `amount` string — Total amount of the charge. - `amount_approved` string — Amount approved by the processor. - `amount_refunded` string — Total amount refunded so far. - `amount_captured` string — Amount that has been captured from the authorization. - `amount_voided` string — Amount that has been voided. - `tip_amount` string — Tip amount included in the transaction. - `payarc_fees` string — Fees charged by Payarc. - `type` string — Charge type (e.g., Sale). - `customer_email` string — Customer’s email address. - `net_amount` boolean — Net amount after fees and adjustments. - `captured` boolean — Indicates whether the charge has been captured (0/1). - `is_refunded` boolean — Indicates whether the charge has been refunded (0/1). - `status` string — Current charge status (e.g., authorized, captured). - `auth_code` string — Authorization code returned by the processor. - `failure_code` string — Processor failure code, if the charge failed. - `failure_message` string — Human-readable failure message. - `charge_description` string — Description of the charge. - `kount_details` string — Fraud details returned from Kount. - `kount_status` string — Fraud decision status from Kount. - `statement_description` string — Description shown on the cardholder’s statement. - `invoice` string — Associated invoice ID. - `under_review` string — Indicates whether the charge is under review (0/1). - `created_at` string — Unix timestamp when the charge was created. - `updated_at` string — Unix timestamp when the charge was last updated. - `email` string — Alternate customer email. - `phone_number` string — Customer phone number. - `card_level` string — Card level classification (e.g., LEVEL1). - `sales_tax` string — Sales tax amount. - `purchase_order` string — Purchase order number. - `supplier_reference_number` string — Supplier reference identifier. - `customer_ref_id` string — Merchant-defined customer reference ID. - `ship_to_zip` string — Destination ZIP/postal code. - `amex_descriptor` string — American Express descriptor. - `customer_vat_number` string — Customer VAT number. - `summary_commodity_code` string — Commodity code for Level 3 data. - `shipping_charges` string — Shipping charges amount. - `duty_charges` string — Duty charges amount. - `ship_from_zip` string — Origin ZIP/postal code. - `destination_country_code` string — Destination country code. - `vat_invoice` string — VAT invoice reference. - `order_date` string — Order date. - `tax_category` string — Tax category classification. - `tax_type` string — Type of tax applied. - `tax_rate` string — Tax rate applied. - `tax_amount` string — Calculated tax amount. - `created_by` string — Identifier of the user or system that created the charge. - `terminal_register` object - `terminal` string — Terminal provider name. - `type` string — Terminal type (e.g., GATEWAY). - `code` string — Unique terminal code. - `is_enabled` boolean — Indicates whether the terminal is enabled. - `created_at` string — Timestamp when the terminal was created. - `updated_at` string — Timestamp when the terminal was last updated. - `deleted_at` string — Timestamp when the terminal was deleted, if applicable. - `device_id` string — Associated device identifier. - `pos_identifier` string — POS system identifier. - `datawire_client_id` string — Datawire client identifier. - `amex_level3` string[] — American Express Level 3 data. - `tip_amount_refunded` string — Refunded portion of the tip. - `sales_tax_refunded` string — Refunded portion of sales tax. - `shipping_charges_refunded` string — Refunded shipping charges. - `duty_charges_refunded` string — Refunded duty charges. - `pax_reference_number` string — PAX terminal reference number. - `refund_reason` string — Reason for refund. - `refund_description` string — Description of the refund. - `surcharge` string — Surcharge amount applied. - `toll_amount` string — Toll-related charges. - `airport_fee` string — Airport fee amount. - `health_care` string — Healthcare-related transaction data. - `health_care_type` string — Type of healthcare transaction. - `prescription_amount` string — Prescription-related amount. - `vision_amount` string — Vision care amount. - `clinic_amount` string — Clinic-related charges. - `dental_amount` string — Dental-related charges. - `industry_type` string — Industry classification for the transaction. - `void_reason` string — Reason the charge was voided. - `void_description` string — Description of the void. - `server_id` string — Server identifier that processed the charge. - `external_invoice_id` string — External invoice identifier. - `external_order_id` string — External order identifier - `tsys_response_code` string — TSYS processor response code. - `host_response_code` string — Host system response code. - `host_response_message` string — Host system response message. - `emv_issuer_scripts` string — EMV issuer scripts returned by the processor. - `emv_issuer_authentication_data` string — EMV issuer authentication data. - `host_reference_number` string — Host system reference number. - `sale_terminal_id` string — Terminal ID used for the sale. - `sale_mid` string — Merchant ID used for the sale. - `edc_type` string — Electronic data capture type. - `ecr_reference_number` string — Electronic cash register reference number. - `host_transaction_identifier` string — Host transaction identifier. - `refund` object — List of refund objects associated with the charge. - `data` object[] — Complete refund data - `card` object - `data` object — Compete card data - `object` string — Type of object (Card). - `id` string — Unique identifier for the card. - `address1` string — Cardholder billing address line 1. - `address2` string — Cardholder billing address line 1. - `card_source` string — Source of the card data (e.g., INTERNET). - `card_holder_name` string — Name on the card. - `is_default` string — Indicates whether this is the default card (0/1). - `exp_month` string — Card expiration month. - `exp_year` string — Card expiration year. - `is_verified` string — Indicates whether the card is verified (0/1). - `fingerprint` string — Unique fingerprint for the card. - `city` string — Billing city. - `state` string — Billing state or region. - `zip` string — Billing ZIP/postal code. - `brand` string — Card brand (e.g., V = Visa). - `last4digit` string — Last four digits of the card number. - `first6digit` string — First six digits (BIN). - `country` string — Card issuing country. - `avs_status` string — AVS check result. - `cvc_status` string — CVC check result. - `address_check_passed` boolean — Indicates if address check passed (0/1). - `zip_check_passed` boolean — Indicates if ZIP check passed (0/1). - `customer_id` string — Associated customer ID. - `created_at` string — Unix timestamp when the card was created. - `updated_at` string — Unix timestamp when the card was last updated. - `card_type` string — Card type classification. - `bin_country` string — Country associated with the BIN. - `bank_name` string — Issuing bank name. - `bank_website` string — Issuing bank website. - `bank_phone` string — Issuing bank phone number. - `splits` object - `data` object[] — Complete split data - `object` string — Type of object (ChargeSplit). - `id` string — Unique identifier for the split. - `amount` string — Amount allocated to the split. - `amount_formatted` string — Human-readable formatted amount. - `percent` string — Percentage of the total charge allocated. - `mid` string — Merchant ID receiving the split. - `status` string — Current split status. - `description` string — Description of the split. - `created_at` string — Timestamp when the split was created. - `updated_at` string — Timestamp when the split was last updated. - `meta` object, required - `include` string[] — List of related resources included in the response. - `custom` string[] — Custom metadata included in the response. ## Other responses - `422` — Unprocessable Entity --- [API](https://skmtc.net/payarc/apis/payarc-sandbox.md) · [All operations](https://skmtc.net/payarc/apis/payarc-sandbox/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/payarc/payarc-sandbox/revisions/face82bdd778/schema)