> ## Documentation Index > Fetch the complete documentation index at: https://docs.slm.m1amdocs.com/llms.txt > Use this file to discover all available pages before exploring further. # Reverse a Payment Reverse a payment action can be used to reverse payments made using the [create a payment call](Create_a_Payment) and is only applicable for payments made using the **Merchant Accepted Payment** payment method. When the payment is reversed, status appears as `Failure`. The associated Transaction will be in TransactionStatus `Cancelled`. **Note:** For all other payment methods, use a [Refund](Refunds) call instead. ## HTTP Request `POST https://api.vindicia.com/payments/:payment/actions/reverse` ## Route (URL) Parameters | Parameter | Default | Description | Required | | - | - | - | - | | payment | n/a | The **id** or the **vid** of the payment to reverse | Yes | ## Accepts None. ## Returns JSON - A full [Payment](Payments) object. ## Example Request ``` curl -X POST \ -u acaff38d462f9430d5cbcbaf:a575771fc679b9de \ "https://api.staging.us-west.vindicia.com/payments/pay_1542t/actions/reverse" ``` ## Example Response The above command returns JSON structured like this: ``` { "object": "Payment", "id": "pay_1542t", "vid": "321337b1cab8a772226361775067d2f0edc6da4c", "created": "2021-09-21T15:53:50-07:00", "account": { "object": "Account", "id": "nzCBtsC5-prtkjSNreuKfXAGoSs", "vid": "9ab512ff5f5122c38e136f505a63d39fd9d52261" }, "subscription": { "object": "Subscription", "id": "sub_Buoa4RPs8sxHZr4d6TC5qe_Wks0", "vid": "55ede4ee9230e90fa1887e5b28aaec61e16025d8" }, "invoice": { "object": "Invoice", "id": "sub_Buoa4RPs8sxHZr4d6TC5qe_Wks0-00000000", "vid": "9ffb84181078c521763e034bc59fda5ff4d5922a", "billing_service_period_start": "2021-09-21T00:00:00-07:00", "billing_service_period_end": "2021-10-20T00:00:00-07:00", "due_date": "2021-11-20T00:00:00-08:00", "invoice_date": "2021-09-21T00:00:00-07:00", "status": "Due", "invoice_currency": "USD", "invoice_balance": 5, "gross_charges_total": 5, "tax_charges_total": 0, "sales_tax_address": { "object": "Address", "vid": "a55528d1dfc10ba2aee1182984cc7c1494081d38", "name": "Home", "line1": "11235 Fibonacci St.", "city": "SAN MATEO", "district": "CA", "postal_code": "94403", "country": "US" }, "credit_total": 0, "payments_received_total": 1.99, "invoice_line_items": { "object": "List", "data": [ { "object": "InvoiceItem", "index_number": 0, "type": "RecurringCharge", "sku": "bp_ailkyMoVZg5PrMtnTAN5fZaaUdA", "description": "product default plan ailkyMoVZg5PrMtnTAN", "quantity": 1, "unit_amount": 0, "tax_classification": "TaxExempt", "item_added": "2021-09-21T00:00:00-07:00", "item_removed": null, "item_serviceperiod_start": "2021-09-21T00:00:00-07:00", "item_serviceperiod_end": "2021-10-20T00:00:00-07:00", "billing_plan": { "object": "BillingPlan", "id": "bp_ailkyMoVZg5PrMtnTAN5fZaaUdA", "vid": "c4f0757bb3539eac1db58f4b306d6f7f711ebeec" } }, { "object": "InvoiceItem", "index_number": 1, "type": "RecurringCharge", "sku": "1hxIz8-_Iv9eNrdQhNnt43n0NWc", "description": "Test Product Description", "quantity": 1, "unit_amount": 5, "tax_classification": "TaxExempt", "item_added": "2021-09-21T00:00:00-07:00", "item_removed": null, "item_serviceperiod_start": "2021-09-21T00:00:00-07:00", "item_serviceperiod_end": "2021-10-20T00:00:00-07:00", "subscription_item": { "object": "SubscriptionItem", "id": "sub_item_VS88Yr_81gY01PZ01pNoAx9GgIk", "vid": "706de2f391644a3ad50ae0d33063d678563315e2" } } ], "total_count": 2 }, "invoice_tax_items": { "object": "List", "data": [ { "object": "InvoiceItem", "index_number": 2, "type": "Tax", "sku": "VIN_SALES_TAX", "description": "Sales Tax Total", "quantity": 1, "unit_amount": 0, "tax_classification": "TaxExempt", "item_added": "2021-09-21T00:00:00-07:00", "item_removed": null, "item_serviceperiod_start": "2021-09-21T00:00:00-07:00", "item_serviceperiod_end": "2021-10-20T00:00:00-07:00" } ], "total_count": 1 }, "invoice_payments": { "object": "List", "data": [ { "object": "Transaction", "id": "IWC00066765", "vid": "ea07d80c40f3458ebf03fed9579e0a72f3e853bc", "created": "2021-09-21T15:53:51-07:00", "amount": 1.99, "currency": "USD", "account": { "object": "Account", "id": "nzCBtsC5-prtkjSNreuKfXAGoSs", "vid": "9ab512ff5f5122c38e136f505a63d39fd9d52261", "created": "2021-09-21T15:52:50-07:00", "email": "devnull@example.com", "email_type": "html", "company": "Lorem Ipsum Inc", "name": "Forest Chump", "shipping_address": { "object": "Address", "vid": "7bf5a88dcfaa0f17a22ce6aae671cc69a4d6c7f3", "name": "home", "line1": "11235 Fibonacci St.", "city": "San Mateo", "district": "CA", "postal_code": "94403", "country": "US", "phone": "(650) 555-1212x42" }, "payment_methods": { "object": "List", "data": [ { "object": "PaymentMethod", "id": "pm1_map_GqQ3IrVcaBdy9J7gPw71hA34OrM", "vid": "76b70fae5c796d1327fb3a6db756f75a8600b991", "created": "2021-09-21T15:52:50-07:00", "type": "MerchantAcceptedPayment", "merchant_accepted_payment": { "object": "MerchantAcceptedPayment", "amount": 0, "currency": "USD", "created": "2021-09-21T15:52:51-07:00", "payment_type": "WTF", "payment_id": "pId_GqQ3IrVcaBdy9J7gPw71hA34OrM", "account": "XXXXXXXXXXXXXXXXXXXXXXX4OrM", "last_digits": "4OrM" }, "account_holder": "pm1_Forest Chump", "billing_address": { "object": "Address", "vid": "636d13150ea64f071abfb60e578f47f1c097a0de", "name": "home", "line1": "11235 Fibonacci St.", "city": "San Mateo", "district": "CA", "postal_code": "94403", "country": "US", "phone": "(650) 555-1212x42" }, "customer_specified_type": "pm1_MACC", "primary": true, "active": true } ], "total_count": 1 } }, "source_payment_method": { "object": "PaymentMethod", "id": "pm2_map_tCLJ6gY5h_t5mZ5bjhdUyUdIThs", "vid": "825e2a81c10ba3d52e83ad50cc4aa669d098391a", "created": "2021-09-21T15:52:51-07:00", "type": "MerchantAcceptedPayment", "merchant_accepted_payment": { "object": "MerchantAcceptedPayment", "amount": 1.99, "currency": "USD", "created": "2021-09-21T15:52:52-07:00", "payment_type": "WTF", "payment_id": "pId_tCLJ6gY5h_t5mZ5bjhdUyUdIThs", "account": "XXXXXXXXXXXXXXXXXXXXXXXIThs", "last_digits": "IThs" }, "account_holder": "pm2_Forest Chump", "billing_address": { "object": "Address", "vid": "127a80b50f8517ba7e7d046a2e087fce4b5a7e0f", "name": "home", "line1": "11235 Fibonacci St.", "city": "San Mateo", "district": "CA", "postal_code": "94403", "country": "US", "phone": "(650) 555-1212x42" }, "customer_specified_type": "pm2_MACC", "primary": false, "active": false }, "status_log": { "object": "List", "data": [ { "object": "TransactionStatus", "status": "Cancelled", "created": "2021-09-21T15:55:42-07:00", "payment_method_type": "MerchantAcceptedPayment" }, { "object": "TransactionStatus", "status": "Captured", "created": "2021-09-21T15:55:23-07:00", "payment_method_type": "MerchantAcceptedPayment" }, { "object": "TransactionStatus", "status": "Authorized", "created": "2021-09-21T15:54:13-07:00", "payment_method_type": "MerchantAcceptedPayment", "note": "VIN_900 - N/A" }, { "object": "TransactionStatus", "status": "New", "created": "2021-09-21T15:54:00-07:00", "payment_method_type": "MerchantAcceptedPayment" } ], "total_count": 4 }, "payment_processor": "Vindicia", "shipping_address": { "object": "Address", "vid": "7bf5a88dcfaa0f17a22ce6aae671cc69a4d6c7f3", "name": "home", "line1": "11235 Fibonacci St.", "city": "San Mateo", "district": "CA", "postal_code": "94403", "country": "US", "phone": "(650) 555-1212x42" }, "metadata": { "vin:BillingPlanUnit": "month", "VIN_PartialPaymentTxBId": "1144973", "vin:BillingPlanLength": "1", "vin:BillingPlanDurationInSeconds": "0", "vin:FutureAmount": "5.00" }, "items": { "object": "List", "data": [ { "object": "TransactionItem", "sku": "VIN_PartialTxBPayment", "index_number": 1, "item_type": "Purchase", "name": "Partial Payment for Invoice sub_Buoa4RPs8sxHZr4d6TC5qe_Wks0-00000000", "price": 1.99, "quantity": 1, "tax_classification": "TaxExempt", "service_period_starts": "2021-09-21T00:00:00-07:00", "service_period_ends": "2021-10-20T00:00:00-07:00", "tax_type": "Exclusive Sales", "subtotal": 1.99, "total": 1.99 }, { "object": "TransactionItem", "sku": "Total Tax", "index_number": 2, "item_type": "Purchase", "name": "Total Tax", "price": 0, "quantity": 1, "tax_classification": "TaxExempt", "service_period_starts": "2021-09-21T00:00:00-07:00", "service_period_ends": "2021-10-20T00:00:00-07:00", "tax_type": "Exclusive Sales", "discount": 0, "subtotal": 0, "total": 0 } ], "total_count": 2 }, "sales_tax_address": { "object": "Address", "vid": "a55528d1dfc10ba2aee1182984cc7c1494081d38", "name": "home", "line1": "11235 Fibonacci St.", "city": "SAN MATEO", "district": "CA", "postal_code": "94403", "country": "US" }, "subscription_sequence": 1, "billing_plan_sequence": 1, "original_billing_date": "2021-09-21T00:00:00-07:00", "subscription": { "object": "Subscription", "id": "sub_Buoa4RPs8sxHZr4d6TC5qe_Wks0", "vid": "55ede4ee9230e90fa1887e5b28aaec61e16025d8" } } ], "total_count": 1 }, "account": { "object": "Account", "id": "nzCBtsC5-prtkjSNreuKfXAGoSs", "vid": "9ab512ff5f5122c38e136f505a63d39fd9d52261" }, "subscription": { "object": "Subscription", "id": "sub_Buoa4RPs8sxHZr4d6TC5qe_Wks0", "vid": "55ede4ee9230e90fa1887e5b28aaec61e16025d8" }, "billing_sequence": 0 }, "payment_method": { "object": "PaymentMethod", "id": "pm2_map_tCLJ6gY5h_t5mZ5bjhdUyUdIThs", "vid": "825e2a81c10ba3d52e83ad50cc4aa669d098391a" }, "amount": 1.99, "currency": "USD", "overage_disposition": "applyToThisAutoBill", "transaction": { "object": "Transaction", "id": "IWC00066765", "vid": "ea07d80c40f3458ebf03fed9579e0a72f3e853bc", "created": "2021-09-21T15:53:51-07:00", "amount": 1.99, "currency": "USD", "account": { "object": "Account", "id": "nzCBtsC5-prtkjSNreuKfXAGoSs", "vid": "9ab512ff5f5122c38e136f505a63d39fd9d52261", "created": "2021-09-21T15:52:50-07:00", "email": "devnull@example.com", "email_type": "html", "company": "Lorem Ipsum Inc", "name": "Forest Chump /home/kpeters/repos/cashbox/qa/client/rest/perl/rest_payments.t", "shipping_address": { "object": "Address", "vid": "7bf5a88dcfaa0f17a22ce6aae671cc69a4d6c7f3", "name": "home", "line1": "11235 Fibonacci St.", "city": "San Mateo", "district": "CA", "postal_code": "94403", "country": "US", "phone": "(650) 555-1212x42" }, "payment_methods": { "object": "List", "data": [ { "object": "PaymentMethod", "id": "pm1_map_GqQ3IrVcaBdy9J7gPw71hA34OrM", "vid": "76b70fae5c796d1327fb3a6db756f75a8600b991", "created": "2021-09-21T15:52:50-07:00", "type": "MerchantAcceptedPayment", "merchant_accepted_payment": { "object": "MerchantAcceptedPayment", "amount": 0, "currency": "USD", "created": "2021-09-21T15:52:51-07:00", "payment_type": "WTF", "payment_id": "pId_GqQ3IrVcaBdy9J7gPw71hA34OrM", "account": "XXXXXXXXXXXXXXXXXXXXXXX4OrM", "last_digits": "4OrM" }, "account_holder": "pm1_Forest Chump", "billing_address": { "object": "Address", "vid": "636d13150ea64f071abfb60e578f47f1c097a0de", "name": "home", "line1": "11235 Fibonacci St.", "city": "San Mateo", "district": "CA", "postal_code": "94403", "country": "US", "phone": "(650) 555-1212x42" }, "customer_specified_type": "pm1_MACC", "primary": true, "active": true } ], "total_count": 1 } }, "source_payment_method": { "object": "PaymentMethod", "id": "pm2_map_tCLJ6gY5h_t5mZ5bjhdUyUdIThs", "vid": "825e2a81c10ba3d52e83ad50cc4aa669d098391a", "created": "2021-09-21T15:52:51-07:00", "type": "MerchantAcceptedPayment", "merchant_accepted_payment": { "object": "MerchantAcceptedPayment", "amount": 1.99, "currency": "USD", "created": "2021-09-21T15:52:52-07:00", "payment_type": "WTF", "payment_id": "pId_tCLJ6gY5h_t5mZ5bjhdUyUdIThs", "account": "XXXXXXXXXXXXXXXXXXXXXXXIThs", "last_digits": "IThs" }, "account_holder": "pm2_Forest Chump", "billing_address": { "object": "Address", "vid": "127a80b50f8517ba7e7d046a2e087fce4b5a7e0f", "name": "home", "line1": "11235 Fibonacci St.", "city": "San Mateo", "district": "CA", "postal_code": "94403", "country": "US", "phone": "(650) 555-1212x42" }, "customer_specified_type": "pm2_MACC", "primary": false, "active": false }, "status_log": { "object": "List", "data": [ { "object": "TransactionStatus", "status": "Cancelled", "created": "2021-09-21T15:55:42-07:00", "payment_method_type": "MerchantAcceptedPayment" }, { "object": "TransactionStatus", "status": "Captured", "created": "2021-09-21T15:55:23-07:00", "payment_method_type": "MerchantAcceptedPayment" }, { "object": "TransactionStatus", "status": "Authorized", "created": "2021-09-21T15:54:13-07:00", "payment_method_type": "MerchantAcceptedPayment", "note": "VIN_900 - N/A" }, { "object": "TransactionStatus", "status": "New", "created": "2021-09-21T15:54:00-07:00", "payment_method_type": "MerchantAcceptedPayment" } ], "total_count": 4 }, "payment_processor": "Vindicia", "shipping_address": { "object": "Address", "vid": "7bf5a88dcfaa0f17a22ce6aae671cc69a4d6c7f3", "name": "home", "line1": "11235 Fibonacci St.", "city": "San Mateo", "district": "CA", "postal_code": "94403", "country": "US", "phone": "(650) 555-1212x42" }, "metadata": { "vin:BillingPlanUnit": "month", "VIN_PartialPaymentTxBId": "1144973", "vin:BillingPlanLength": "1", "vin:BillingPlanDurationInSeconds": "0", "vin:FutureAmount": "5.00" }, "items": { "object": "List", "data": [ { "object": "TransactionItem", "sku": "VIN_PartialTxBPayment", "index_number": 1, "item_type": "Purchase", "name": "Partial Payment for Invoice sub_Buoa4RPs8sxHZr4d6TC5qe_Wks0-00000000", "price": 1.99, "quantity": 1, "tax_classification": "TaxExempt", "service_period_starts": "2021-09-21T00:00:00-07:00", "service_period_ends": "2021-10-20T00:00:00-07:00", "tax_type": "Exclusive Sales", "subtotal": 1.99, "total": 1.99 }, { "object": "TransactionItem", "sku": "Total Tax", "index_number": 2, "item_type": "Purchase", "name": "Total Tax", "price": 0, "quantity": 1, "tax_classification": "TaxExempt", "service_period_starts": "2021-09-21T00:00:00-07:00", "service_period_ends": "2021-10-20T00:00:00-07:00", "tax_type": "Exclusive Sales", "discount": 0, "subtotal": 0, "total": 0 } ], "total_count": 2 }, "sales_tax_address": { "object": "Address", "vid": "a55528d1dfc10ba2aee1182984cc7c1494081d38", "name": "Test Script: /home/kpeters/repos/cashbox/qa/client/rest/perl/rest_payments.t", "line1": "11235 Fibonacci St.", "city": "SAN MATEO", "district": "CA", "postal_code": "94403", "country": "US" }, "subscription_sequence": 1, "billing_plan_sequence": 1, "original_billing_date": "2021-09-21T00:00:00-07:00", "subscription": { "object": "Subscription", "id": "sub_Buoa4RPs8sxHZr4d6TC5qe_Wks0", "vid": "55ede4ee9230e90fa1887e5b28aaec61e16025d8" } }, "status": "Failure" } ``` **Parent topic:**[Payments](../topics/Payments) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.