--- updatedAt: 2025-08-12T18:55:16.000Z agentTools: projectIndex: https://docs.staxpayments.com/llms.txt --- # Void Transaction Sets a transaction to void, ending the transaction before it's processed. The Void Transaction endpoint allows you to cancel a transaction before it is processed (settled). Voiding a transaction prevents it from being captured and stops any associated fees from being assessed. When a transaction is voided, a child transaction with type = void is created and linked to the original transaction. ## Key Points **Timing is Critical:** Transactions can only be voided before they have been batched (settled). Transactions typically batch around 8 pm EST, but this can vary based on merchant configurations. In some cases, the window to void a transaction is very small. **Irreversible Action:** Once a transaction is batched, it cannot be voided. You must issue a refund instead. **Child Transactions:** The void action results in a new child transaction linked to the original transaction for tracking purposes. *** ## Testing Environment: In a sandbox account, transactions are not refundable until 12 am EST. *** ## Settlement Tokenization Considerations: If your merchant account has Settlement Tokenization enabled and the transaction is not yet available for a refund, this endpoint will return a status code 422 with the message: `This transaction is not yet available to be refunded via API. You can still complete this transaction through the card present flow.` In such cases, you may use the POST /terminal/void-or-refund endpoint instead. *** ## Usage Notes **Void Eligibility:** Before attempting to void a transaction, check if it is eligible by verifying it has not been batched. The `is_voidable` flag on the transaction object can help determine this. **No Partial Voids:** Partial voids are not supported. You must void the entire transaction amount. **Error Handling:** If a void request is sent after the transaction has been batched, the API will return an error indicating the transaction cannot be voided. **Contact Support:** For any uncertainties regarding the void window or transaction statuses, reach out to support for assistance. *** ## Response Structure | Code | Response | Reason | | :--- | :-------------------- | :---------------------------------------------------------------------------------------- | | 200 | Success | Returns the original transaction object with an added child transaction of `type = void`. | | 400 | Bad Request | Invalid request parameters. | | 401 | Unauthorized | Authentication failed. | | 404 | Not Found | Transaction ID does not exist. | | 422 | Unprocessable Entity | Transaction cannot be voided (e.g., already batched). | | 500 | Internal Server Error | An unexpected error occurred on the server. | *** ## Alternative Endpoint [`POST /transaction/{id}/void-or-refund`](https://docs.staxpayments.com/reference/void-or-refund-transaction): This endpoint automatically determines whether to void or refund the transaction based on its status. *** ## Important Considerations ### Voiding vs. Refunding Voiding is only possible before settlement. After settlement, you must process a refund. ### Batch Times Be aware of your merchant account's batch processing times to effectively manage voids. ### Terminal Transactions For transactions processed through terminals, and if Settlement Tokenization is enabled, you may need to use terminal-specific endpoints. # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "stax-api", "version": "0.1" }, "servers": [ { "url": "https://apiprod.fattlabs.com/" } ], "components": { "securitySchemes": { "ApiKeyAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "API key for merchant-level operations. Provides access to merchant-specific endpoints including transactions, payments, customer management, and merchant account settings. This key is scoped to a single merchant account and cannot access partner-level functionality." } } }, "security": [ { "ApiKeyAuth": [] } ], "paths": { "/transaction/{id}/void": { "post": { "summary": "Void Transaction", "description": "Sets a transaction to void, ending the transaction before it's processed.", "operationId": "void-transaction", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": \"ba9bf00c-c54d-48f8-8400-902cb3aacd21\",\n \"invoice_id\": \"\",\n \"reference_id\": \"\",\n \"recurring_transaction_id\": \"\",\n \"type\": \"charge\",\n \"source\": null,\n \"merchant_id\": \"dd36b936-1eb7-4ece-bebc-b514c6a36ebd\",\n \"user_id\": \"41e60252-4f23-48de-a64f-e5a1e8a9359c\",\n \"customer_id\": \"d45ee88c-8b27-4be8-8d81-77dda1b81826\",\n \"payment_method_id\": \"129520d1-3844-45fd-a0b1-afb66bcdc74c\",\n \"is_manual\": null,\n \"success\": true,\n \"message\": null,\n \"meta\": {\n \"tax\": 2,\n \"subtotal\": 10\n },\n \"total\": 1,\n \"method\": \"card\",\n \"pre_auth\": false,\n \"last_four\": \"1111\",\n \"receipt_email_at\": \"2017-05-19 14:40:31\",\n \"receipt_sms_at\": null,\n \"created_at\": \"2017-05-19 13:50:44\",\n \"updated_at\": \"2017-05-19 14:40:31\",\n \"total_refunded\": null,\n \"is_refundable\": false,\n \"is_voided\": true,\n \"is_voidable\": false,\n \"schedule_id\": null,\n \"customer\": {\n \"id\": \"d45ee88c-8b27-4be8-8d81-77dda1b81826\",\n \"firstname\": \"John\",\n \"lastname\": \"Smith\",\n \"company\": \"ABC INC\",\n \"email\": \"demo@abc.com\",\n \"cc_emails\": [\n \"demo1@abc.com\",\n \"demo2@abc.com\"\n ],\n \"phone\": \"1234567898\",\n \"address_1\": \"123 Rite Way\",\n \"address_2\": \"Unit 12\",\n \"address_city\": \"Orlando\",\n \"address_state\": \"FL\",\n \"address_zip\": \"32801\",\n \"address_country\": \"USA\",\n \"notes\": null,\n \"reference\": \"BARTLE\",\n \"options\": \"\",\n \"created_at\": \"2017-05-08 19:22:51\",\n \"updated_at\": \"2017-05-08 19:23:46\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/fe3e929dd80f1653c3a4b82812660061\"\n },\n \"child_transactions\": [\n {\n \"id\": \"04497525-565c-4169-bb6d-5a4df399d255\",\n \"invoice_id\": \"\",\n \"reference_id\": \"ba9bf00c-c54d-48f8-8400-902cb3aacd21\",\n \"recurring_transaction_id\": \"\",\n \"type\": \"void\",\n \"source\": null,\n \"merchant_id\": \"dd36b936-1eb7-4ece-bebc-b514c6a36ebd\",\n \"user_id\": \"41e60252-4f23-48de-a64f-e5a1e8a9359c\",\n \"customer_id\": \"d45ee88c-8b27-4be8-8d81-77dda1b81826\",\n \"payment_method_id\": \"129520d1-3844-45fd-a0b1-afb66bcdc74c\",\n \"is_manual\": null,\n \"success\": true,\n \"message\": null,\n \"meta\": {\n \"tax\": 2,\n \"subtotal\": 10\n },\n \"total\": 1,\n \"method\": \"card\",\n \"pre_auth\": false,\n \"last_four\": \"1111\",\n \"receipt_email_at\": null,\n \"receipt_sms_at\": null,\n \"created_at\": \"2017-05-19 15:11:32\",\n \"updated_at\": \"2017-05-19 15:11:32\",\n \"total_refunded\": null,\n \"is_refundable\": false,\n \"is_voided\": null,\n \"is_voidable\": false,\n \"schedule_id\": null,\n \"customer\": {\n \"id\": \"d45ee88c-8b27-4be8-8d81-77dda1b81826\",\n \"firstname\": \"John\",\n \"lastname\": \"Smith\",\n \"company\": \"ABC INC\",\n \"email\": \"demo@abc.com\",\n \"cc_emails\": [\n \"demo1@abc.com\",\n \"demo2@abc.com\"\n ],\n \"phone\": \"1234567898\",\n \"address_1\": \"123 Rite Way\",\n \"address_2\": \"Unit 12\",\n \"address_city\": \"Orlando\",\n \"address_state\": \"FL\",\n \"address_zip\": \"32801\",\n \"address_country\": \"USA\",\n \"notes\": null,\n \"reference\": \"BARTLE\",\n \"options\": \"\",\n \"created_at\": \"2017-05-08 19:22:51\",\n \"updated_at\": \"2017-05-08 19:23:46\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/fe3e929dd80f1653c3a4b82812660061\"\n },\n \"child_transactions\": [],\n \"files\": [],\n \"payment_method\": {\n \"id\": \"129520d1-3844-45fd-a0b1-afb66bcdc74c\",\n \"customer_id\": \"d45ee88c-8b27-4be8-8d81-77dda1b81826\",\n \"merchant_id\": \"dd36b936-1eb7-4ece-bebc-b514c6a36ebd\",\n \"user_id\": \"41e60252-4f23-48de-a64f-e5a1e8a9359c\",\n \"nickname\": \"VISA: Steven Smith Jr. (ending in: 1111)\",\n \"is_default\": 1,\n \"method\": \"card\",\n \"person_name\": \"Steven Smith Jr.\",\n \"card_type\": \"visa\",\n \"card_last_four\": \"1111\",\n \"card_exp\": \"042019\",\n \"bank_name\": null,\n \"bank_type\": null,\n \"bank_holder_type\": null,\n \"address_1\": null,\n \"address_2\": null,\n \"address_city\": null,\n \"address_state\": null,\n \"address_zip\": \"32944\",\n \"address_country\": \"USA\",\n \"purged_at\": null,\n \"deleted_at\": null,\n \"created_at\": \"2017-05-17 19:56:59\",\n \"updated_at\": \"2017-05-17 19:56:59\",\n \"card_exp_datetime\": \"2019-04-30 23:59:59\",\n \"customer\": {\n \"id\": \"d45ee88c-8b27-4be8-8d81-77dda1b81826\",\n \"firstname\": \"John\",\n \"lastname\": \"Smith\",\n \"company\": \"ABC INC\",\n \"email\": \"demo@abc.com\",\n \"cc_emails\": [\n \"demo1@abc.com\",\n \"demo2@abc.com\"\n ],\n \"phone\": \"1234567898\",\n \"address_1\": \"123 Rite Way\",\n \"address_2\": \"Unit 12\",\n \"address_city\": \"Orlando\",\n \"address_state\": \"FL\",\n \"address_zip\": \"32801\",\n \"address_country\": \"USA\",\n \"notes\": null,\n \"reference\": \"BARTLE\",\n \"options\": \"\",\n \"created_at\": \"2017-05-08 19:22:51\",\n \"updated_at\": \"2017-05-08 19:23:46\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/fe3e929dd80f1653c3a4b82812660061\"\n }\n },\n \"user\": {\n \"id\": \"41e60252-4f23-48de-a64f-e5a1e8a9359c\",\n \"system_admin\": true,\n \"name\": \"Benji\",\n \"email\": \"contact@example.com\",\n \"email_verification_sent_at\": \"2016-12-01 16:18:46\",\n \"email_verified_at\": \"2016-12-01 16:18:46\",\n \"is_api_key\": false,\n \"created_at\": \"2016-12-01 16:18:46\",\n \"updated_at\": \"2017-01-27 20:10:53\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/772cbf95746d7da86789cc3634c46ba8\",\n \"team_admin\": null,\n \"team_enabled\": null,\n \"team_role\": null,\n \"merchant_options\": [],\n \"is_portal\": false\n }\n }\n ],\n \"files\": [],\n \"payment_method\": {\n \"id\": \"129520d1-3844-45fd-a0b1-afb66bcdc74c\",\n \"customer_id\": \"d45ee88c-8b27-4be8-8d81-77dda1b81826\",\n \"merchant_id\": \"dd36b936-1eb7-4ece-bebc-b514c6a36ebd\",\n \"user_id\": \"41e60252-4f23-48de-a64f-e5a1e8a9359c\",\n \"nickname\": \"VISA: Steven Smith Jr. (ending in: 1111)\",\n \"is_default\": 1,\n \"method\": \"card\",\n \"person_name\": \"Steven Smith Jr.\",\n \"card_type\": \"visa\",\n \"card_last_four\": \"1111\",\n \"card_exp\": \"042019\",\n \"bank_name\": null,\n \"bank_type\": null,\n \"bank_holder_type\": null,\n \"address_1\": null,\n \"address_2\": null,\n \"address_city\": null,\n \"address_state\": null,\n \"address_zip\": \"32944\",\n \"address_country\": \"USA\",\n \"purged_at\": null,\n \"deleted_at\": null,\n \"created_at\": \"2017-05-17 19:56:59\",\n \"updated_at\": \"2017-05-17 19:56:59\",\n \"card_exp_datetime\": \"2019-04-30 23:59:59\",\n \"customer\": {\n \"id\": \"d45ee88c-8b27-4be8-8d81-77dda1b81826\",\n \"firstname\": \"John\",\n \"lastname\": \"Smith\",\n \"company\": \"ABC INC\",\n \"email\": \"demo@abc.com\",\n \"cc_emails\": [\n \"demo1@abc.com\",\n \"demo2@abc.com\"\n ],\n \"phone\": \"1234567898\",\n \"address_1\": \"123 Rite Way\",\n \"address_2\": \"Unit 12\",\n \"address_city\": \"Orlando\",\n \"address_state\": \"FL\",\n \"address_zip\": \"32801\",\n \"address_country\": \"USA\",\n \"notes\": null,\n \"reference\": \"BARTLE\",\n \"options\": \"\",\n \"created_at\": \"2017-05-08 19:22:51\",\n \"updated_at\": \"2017-05-08 19:23:46\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/fe3e929dd80f1653c3a4b82812660061\"\n }\n },\n \"user\": {\n \"id\": \"41e60252-4f23-48de-a64f-e5a1e8a9359c\",\n \"system_admin\": true,\n \"name\": \"Benji\",\n \"email\": \"contact@example.com\",\n \"email_verification_sent_at\": \"2016-12-01 16:18:46\",\n \"email_verified_at\": \"2016-12-01 16:18:46\",\n \"is_api_key\": false,\n \"created_at\": \"2016-12-01 16:18:46\",\n \"updated_at\": \"2017-01-27 20:10:53\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/772cbf95746d7da86789cc3634c46ba8\",\n \"team_admin\": null,\n \"team_enabled\": null,\n \"team_role\": null,\n \"merchant_options\": [],\n \"is_portal\": false\n }\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "ba9bf00c-c54d-48f8-8400-902cb3aacd21" }, "invoice_id": { "type": "string", "example": "" }, "reference_id": { "type": "string", "example": "" }, "recurring_transaction_id": { "type": "string", "example": "" }, "type": { "type": "string", "example": "charge" }, "source": {}, "merchant_id": { "type": "string", "example": "dd36b936-1eb7-4ece-bebc-b514c6a36ebd" }, "user_id": { "type": "string", "example": "41e60252-4f23-48de-a64f-e5a1e8a9359c" }, "customer_id": { "type": "string", "example": "d45ee88c-8b27-4be8-8d81-77dda1b81826" }, "payment_method_id": { "type": "string", "example": "129520d1-3844-45fd-a0b1-afb66bcdc74c" }, "is_manual": {}, "success": { "type": "boolean", "example": true, "default": true }, "message": {}, "meta": { "type": "object", "properties": { "tax": { "type": "integer", "example": 2, "default": 0 }, "subtotal": { "type": "integer", "example": 10, "default": 0 } } }, "total": { "type": "integer", "example": 1, "default": 0 }, "method": { "type": "string", "example": "card" }, "pre_auth": { "type": "boolean", "example": false, "default": true }, "last_four": { "type": "string", "example": "1111" }, "receipt_email_at": { "type": "string", "example": "2017-05-19 14:40:31" }, "receipt_sms_at": {}, "created_at": { "type": "string", "example": "2017-05-19 13:50:44" }, "updated_at": { "type": "string", "example": "2017-05-19 14:40:31" }, "total_refunded": {}, "is_refundable": { "type": "boolean", "example": false, "default": true }, "is_voided": { "type": "boolean", "example": true, "default": true }, "is_voidable": { "type": "boolean", "example": false, "default": true }, "schedule_id": {}, "customer": { "type": "object", "properties": { "id": { "type": "string", "example": "d45ee88c-8b27-4be8-8d81-77dda1b81826" }, "firstname": { "type": "string", "example": "John" }, "lastname": { "type": "string", "example": "Smith" }, "company": { "type": "string", "example": "ABC INC" }, "email": { "type": "string", "example": "demo@abc.com" }, "cc_emails": { "type": "array", "items": { "type": "string", "example": "demo1@abc.com" } }, "phone": { "type": "string", "example": "1234567898" }, "address_1": { "type": "string", "example": "123 Rite Way" }, "address_2": { "type": "string", "example": "Unit 12" }, "address_city": { "type": "string", "example": "Orlando" }, "address_state": { "type": "string", "example": "FL" }, "address_zip": { "type": "string", "example": "32801" }, "address_country": { "type": "string", "example": "USA" }, "notes": {}, "reference": { "type": "string", "example": "BARTLE" }, "options": { "type": "string", "example": "" }, "created_at": { "type": "string", "example": "2017-05-08 19:22:51" }, "updated_at": { "type": "string", "example": "2017-05-08 19:23:46" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/fe3e929dd80f1653c3a4b82812660061" } } }, "child_transactions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "04497525-565c-4169-bb6d-5a4df399d255" }, "invoice_id": { "type": "string", "example": "" }, "reference_id": { "type": "string", "example": "ba9bf00c-c54d-48f8-8400-902cb3aacd21" }, "recurring_transaction_id": { "type": "string", "example": "" }, "type": { "type": "string", "example": "void" }, "source": {}, "merchant_id": { "type": "string", "example": "dd36b936-1eb7-4ece-bebc-b514c6a36ebd" }, "user_id": { "type": "string", "example": "41e60252-4f23-48de-a64f-e5a1e8a9359c" }, "customer_id": { "type": "string", "example": "d45ee88c-8b27-4be8-8d81-77dda1b81826" }, "payment_method_id": { "type": "string", "example": "129520d1-3844-45fd-a0b1-afb66bcdc74c" }, "is_manual": {}, "success": { "type": "boolean", "example": true, "default": true }, "message": {}, "meta": { "type": "object", "properties": { "tax": { "type": "integer", "example": 2, "default": 0 }, "subtotal": { "type": "integer", "example": 10, "default": 0 } } }, "total": { "type": "integer", "example": 1, "default": 0 }, "method": { "type": "string", "example": "card" }, "pre_auth": { "type": "boolean", "example": false, "default": true }, "last_four": { "type": "string", "example": "1111" }, "receipt_email_at": {}, "receipt_sms_at": {}, "created_at": { "type": "string", "example": "2017-05-19 15:11:32" }, "updated_at": { "type": "string", "example": "2017-05-19 15:11:32" }, "total_refunded": {}, "is_refundable": { "type": "boolean", "example": false, "default": true }, "is_voided": {}, "is_voidable": { "type": "boolean", "example": false, "default": true }, "schedule_id": {}, "customer": { "type": "object", "properties": { "id": { "type": "string", "example": "d45ee88c-8b27-4be8-8d81-77dda1b81826" }, "firstname": { "type": "string", "example": "John" }, "lastname": { "type": "string", "example": "Smith" }, "company": { "type": "string", "example": "ABC INC" }, "email": { "type": "string", "example": "demo@abc.com" }, "cc_emails": { "type": "array", "items": { "type": "string", "example": "demo1@abc.com" } }, "phone": { "type": "string", "example": "1234567898" }, "address_1": { "type": "string", "example": "123 Rite Way" }, "address_2": { "type": "string", "example": "Unit 12" }, "address_city": { "type": "string", "example": "Orlando" }, "address_state": { "type": "string", "example": "FL" }, "address_zip": { "type": "string", "example": "32801" }, "address_country": { "type": "string", "example": "USA" }, "notes": {}, "reference": { "type": "string", "example": "BARTLE" }, "options": { "type": "string", "example": "" }, "created_at": { "type": "string", "example": "2017-05-08 19:22:51" }, "updated_at": { "type": "string", "example": "2017-05-08 19:23:46" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/fe3e929dd80f1653c3a4b82812660061" } } }, "child_transactions": { "type": "array" }, "files": { "type": "array" }, "payment_method": { "type": "object", "properties": { "id": { "type": "string", "example": "129520d1-3844-45fd-a0b1-afb66bcdc74c" }, "customer_id": { "type": "string", "example": "d45ee88c-8b27-4be8-8d81-77dda1b81826" }, "merchant_id": { "type": "string", "example": "dd36b936-1eb7-4ece-bebc-b514c6a36ebd" }, "user_id": { "type": "string", "example": "41e60252-4f23-48de-a64f-e5a1e8a9359c" }, "nickname": { "type": "string", "example": "VISA: Steven Smith Jr. (ending in: 1111)" }, "is_default": { "type": "integer", "example": 1, "default": 0 }, "method": { "type": "string", "example": "card" }, "person_name": { "type": "string", "example": "Steven Smith Jr." }, "card_type": { "type": "string", "example": "visa" }, "card_last_four": { "type": "string", "example": "1111" }, "card_exp": { "type": "string", "example": "042019" }, "bank_name": {}, "bank_type": {}, "bank_holder_type": {}, "address_1": {}, "address_2": {}, "address_city": {}, "address_state": {}, "address_zip": { "type": "string", "example": "32944" }, "address_country": { "type": "string", "example": "USA" }, "purged_at": {}, "deleted_at": {}, "created_at": { "type": "string", "example": "2017-05-17 19:56:59" }, "updated_at": { "type": "string", "example": "2017-05-17 19:56:59" }, "card_exp_datetime": { "type": "string", "example": "2019-04-30 23:59:59" }, "customer": { "type": "object", "properties": { "id": { "type": "string", "example": "d45ee88c-8b27-4be8-8d81-77dda1b81826" }, "firstname": { "type": "string", "example": "John" }, "lastname": { "type": "string", "example": "Smith" }, "company": { "type": "string", "example": "ABC INC" }, "email": { "type": "string", "example": "demo@abc.com" }, "cc_emails": { "type": "array", "items": { "type": "string", "example": "demo1@abc.com" } }, "phone": { "type": "string", "example": "1234567898" }, "address_1": { "type": "string", "example": "123 Rite Way" }, "address_2": { "type": "string", "example": "Unit 12" }, "address_city": { "type": "string", "example": "Orlando" }, "address_state": { "type": "string", "example": "FL" }, "address_zip": { "type": "string", "example": "32801" }, "address_country": { "type": "string", "example": "USA" }, "notes": {}, "reference": { "type": "string", "example": "BARTLE" }, "options": { "type": "string", "example": "" }, "created_at": { "type": "string", "example": "2017-05-08 19:22:51" }, "updated_at": { "type": "string", "example": "2017-05-08 19:23:46" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/fe3e929dd80f1653c3a4b82812660061" } } } } }, "user": { "type": "object", "properties": { "id": { "type": "string", "example": "41e60252-4f23-48de-a64f-e5a1e8a9359c" }, "system_admin": { "type": "boolean", "example": true, "default": true }, "name": { "type": "string", "example": "Benji" }, "email": { "type": "string", "example": "contact@example.com" }, "email_verification_sent_at": { "type": "string", "example": "2016-12-01 16:18:46" }, "email_verified_at": { "type": "string", "example": "2016-12-01 16:18:46" }, "is_api_key": { "type": "boolean", "example": false, "default": true }, "created_at": { "type": "string", "example": "2016-12-01 16:18:46" }, "updated_at": { "type": "string", "example": "2017-01-27 20:10:53" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/772cbf95746d7da86789cc3634c46ba8" }, "team_admin": {}, "team_enabled": {}, "team_role": {}, "merchant_options": { "type": "array" }, "is_portal": { "type": "boolean", "example": false, "default": true } } } } } }, "files": { "type": "array" }, "payment_method": { "type": "object", "properties": { "id": { "type": "string", "example": "129520d1-3844-45fd-a0b1-afb66bcdc74c" }, "customer_id": { "type": "string", "example": "d45ee88c-8b27-4be8-8d81-77dda1b81826" }, "merchant_id": { "type": "string", "example": "dd36b936-1eb7-4ece-bebc-b514c6a36ebd" }, "user_id": { "type": "string", "example": "41e60252-4f23-48de-a64f-e5a1e8a9359c" }, "nickname": { "type": "string", "example": "VISA: Steven Smith Jr. (ending in: 1111)" }, "is_default": { "type": "integer", "example": 1, "default": 0 }, "method": { "type": "string", "example": "card" }, "person_name": { "type": "string", "example": "Steven Smith Jr." }, "card_type": { "type": "string", "example": "visa" }, "card_last_four": { "type": "string", "example": "1111" }, "card_exp": { "type": "string", "example": "042019" }, "bank_name": {}, "bank_type": {}, "bank_holder_type": {}, "address_1": {}, "address_2": {}, "address_city": {}, "address_state": {}, "address_zip": { "type": "string", "example": "32944" }, "address_country": { "type": "string", "example": "USA" }, "purged_at": {}, "deleted_at": {}, "created_at": { "type": "string", "example": "2017-05-17 19:56:59" }, "updated_at": { "type": "string", "example": "2017-05-17 19:56:59" }, "card_exp_datetime": { "type": "string", "example": "2019-04-30 23:59:59" }, "customer": { "type": "object", "properties": { "id": { "type": "string", "example": "d45ee88c-8b27-4be8-8d81-77dda1b81826" }, "firstname": { "type": "string", "example": "John" }, "lastname": { "type": "string", "example": "Smith" }, "company": { "type": "string", "example": "ABC INC" }, "email": { "type": "string", "example": "demo@abc.com" }, "cc_emails": { "type": "array", "items": { "type": "string", "example": "demo1@abc.com" } }, "phone": { "type": "string", "example": "1234567898" }, "address_1": { "type": "string", "example": "123 Rite Way" }, "address_2": { "type": "string", "example": "Unit 12" }, "address_city": { "type": "string", "example": "Orlando" }, "address_state": { "type": "string", "example": "FL" }, "address_zip": { "type": "string", "example": "32801" }, "address_country": { "type": "string", "example": "USA" }, "notes": {}, "reference": { "type": "string", "example": "BARTLE" }, "options": { "type": "string", "example": "" }, "created_at": { "type": "string", "example": "2017-05-08 19:22:51" }, "updated_at": { "type": "string", "example": "2017-05-08 19:23:46" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/fe3e929dd80f1653c3a4b82812660061" } } } } }, "user": { "type": "object", "properties": { "id": { "type": "string", "example": "41e60252-4f23-48de-a64f-e5a1e8a9359c" }, "system_admin": { "type": "boolean", "example": true, "default": true }, "name": { "type": "string", "example": "Benji" }, "email": { "type": "string", "example": "contact@example.com" }, "email_verification_sent_at": { "type": "string", "example": "2016-12-01 16:18:46" }, "email_verified_at": { "type": "string", "example": "2016-12-01 16:18:46" }, "is_api_key": { "type": "boolean", "example": false, "default": true }, "created_at": { "type": "string", "example": "2016-12-01 16:18:46" }, "updated_at": { "type": "string", "example": "2017-01-27 20:10:53" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/772cbf95746d7da86789cc3634c46ba8" }, "team_admin": {}, "team_enabled": {}, "team_role": {}, "merchant_options": { "type": "array" }, "is_portal": { "type": "boolean", "example": false, "default": true } } } } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"total\": [\n \"The transaction has already been voided.\"\n ]\n}" } }, "schema": { "type": "object", "properties": { "total": { "type": "array", "items": { "type": "string", "example": "The transaction has already been voided." } } } } } } } }, "deprecated": false } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true } ```