Development URL: https://sandbox.gateway.highwirepayments.com
Production URL: https://api.gateway.highwirepayments.com
Please contact support@highwirepayments.com for development or production credentials.
\nAuthorization is done vai HTTP Basic Authorization which is your merchant_uuid and merchant_api_password separated by a : and Base64 encoded
\nExample: \"Basic base64(merchant_uuid:merchant_api_password)\"
\nIf your authentication fails, you will recieve a 403 response code.
\nUsing This Collection & Variables
\nYou can test via postman by populating the following values in the \"Variables\" section:
\nbase_url: one of the URLs above
merchant_username: the merchant_uuid provided
merchant_password: the merchant_api_password provided
Transaction Lifecycle
\nCard transactions can follow various lifecycle events depending on values that are set and approval of the transaction.
\nAuthorzation without immediate capture
If capture flag on the Authorize method is set to false (it is default by true) then the transaction will require a subsequent capture call in order for the transaction to batch and settle. Transactions processed this way will either return a AUTHORIZED, DECLINED, or FAILED response. While a transaction is in the AUTHORIZED state it can either be captured or voided
Authorization with immediate capture
If the capture flad is set to true, the transaction will be immediatley captured upon a successful authorization. Transactions processed this will either return a CAPTURED, DECLINED, or FAILED response. While the transaction is in the CAPTURED state it can still be voided.
Batching Process
At 8PM ET any transactions that are in the CAPTURED state are BATCHED by the gateway and finalized for settlement. At this point, no adjustments or voids can be made to the transaction and a REFUND will need to be created.
Considerations
\nThe gateway does not support blind credits or refunds for transactions which did not originate on the gateway.
\nOnce a REFUND has been created, it can not be voided and is final.
\nPossible Response Values from Upstream Processors
\nThe response_code value will be from the following table.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"50555245","collectionId":"63609cd6-08f6-4a82-a1ae-bcda7cb63aa2","publishedId":"2sBXVbHDkf","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-12-29T15:14:36.000Z"},"item":[{"name":"Authorize Card","id":"7d8857fd-8cd0-415d-9140-6d34195da8ca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"type\" : \"card\",\n \"capture\": true,\n \"amount\": 500,\n \"card_number\": \"4111111111111111\",\n \"card_expiration\": \"0126\",\n \"card_cvv\": \"123\",\n \"cardholder_billing_address\": \"123 Some Street\",\n \"cardholder_billing_zipcode\": \"12345\",\n \"cardholder_name\": \"Tony Stark\"\n}","options":{"raw":{"language":"json"}}},"url":"/transaction/authorize","description":"To obtain an authorization on a card, use this method.
\nNotable Fields
\ncapture: true by default this indicates if the transaction should automatically be captured and flagged for batching
\namount: this field must be an integer and the cents position is implied, meaning $5.34 would be entered as 534
card_expiration: this field must be formatted as MMYY
Responses
\nA successful response, meaning there were no errors with the data or request will look like the Approval or Decline message examples.
\n","urlObject":{"path":["transaction","authorize"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"9d52e771-e512-4f5f-990a-4fa4120fbbeb","name":"Approval","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"type\" : \"card\",\n \"capture\": false,\n \"amount\": 500,\n \"card_number\": \"4111111111111111\",\n \"card_expiration\": \"0126\",\n \"card_cvv\": \"123\",\n \"cardholder_billing_address\": \"123 Some Street\",\n \"cardholder_billing_zipcode\": \"12345\",\n \"cardholder_name\": \"Tony Stark\"\n}","options":{"raw":{"language":"json"}}},"url":"/transaction/authorize"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Thu, 09 Oct 2025 12:56:00 GMT"},{"key":"Server","value":"HighWireGateway-1.0.0"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"400"}],"cookie":[],"responseTime":null,"body":"{\n \"authorized_datetime\": \"2025-10-09T08:56:05.646701\",\n \"response_code\": \"0000\",\n \"transaction_uuid\": \"f3817adc-1894-4ca7-9e26-89d173c8d485\",\n \"authorization_response_code\": \"PAYPAL\",\n \"transaction_type\": \"AUTHORIZATION\",\n \"voided_amount\": 0,\n \"created_datetime\": \"2025-10-09T08:56:00.431292\",\n \"requested_amount\": 500,\n \"cvv_response\": \"M\",\n \"avs_response\": \"A\",\n \"captured_amount\": 0,\n \"authorized_amount\": 500,\n \"status\": \"AUTHORIZED\"\n}"},{"id":"095e9a40-9a96-43f3-9b68-3eeb98edc5e7","name":"Decline","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"type\" : \"card\",\n \"capture\": false,\n \"amount\": 500,\n \"card_number\": \"4111111111111111\",\n \"card_expiration\": \"0126\",\n \"card_cvv\": \"123\",\n \"cardholder_billing_address\": \"123 Some Street\",\n \"cardholder_billing_zipcode\": \"12345\",\n \"cardholder_name\": \"CCREJECT-BANK_ERROR\"\n}","options":{"raw":{"language":"json"}}},"url":"/transaction/authorize"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Thu, 09 Oct 2025 12:56:49 GMT"},{"key":"Server","value":"HighWireGateway-1.0.0"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"306"}],"cookie":[],"responseTime":null,"body":"{\n \"response_code\": \"5100\",\n \"avs_response\": \"G\",\n \"captured_amount\": 0,\n \"authorized_amount\": 0,\n \"transaction_uuid\": \"6727a7c7-a956-431e-85fa-b3e1b5aade65\",\n \"transaction_type\": \"AUTHORIZATION\",\n \"voided_amount\": 0,\n \"created_datetime\": \"2025-10-09T08:56:49.704142\",\n \"requested_amount\": 500,\n \"cvv_response\": \"P\",\n \"status\": \"DECLINED\"\n}"}],"_postman_id":"7d8857fd-8cd0-415d-9140-6d34195da8ca"},{"name":"Void Card","id":"30defa75-9fc0-4bf7-9548-075c927a5f39","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"type\" : \"card\",\n \"transaction_uuid\" : \"fcf5b648-0f94-4a43-b9ef-08272a0b7b62\"\n}","options":{"raw":{"language":"json"}}},"url":"/transaction/void","description":"An authorization can only be voided while it is in the AUTHORIZED or CAPTURED state.
\n","urlObject":{"path":["transaction","void"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"c07b9331-6882-48c3-9e2b-4fbacc3f4940","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"type\" : \"card\",\n \"transaction_uuid\" : \"f3817adc-1894-4ca7-9e26-89d173c8d485\"\n}","options":{"raw":{"language":"json"}}},"url":"/transaction/void"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Thu, 09 Oct 2025 12:58:49 GMT"},{"key":"Server","value":"HighWireGateway-1.0.0"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"468"}],"cookie":[],"responseTime":null,"body":"{\n \"authorized_datetime\": \"2025-10-09T08:56:06\",\n \"response_code\": \"0000\",\n \"transaction_uuid\": \"f3817adc-1894-4ca7-9e26-89d173c8d485\",\n \"authorization_response_code\": \"PAYPAL\",\n \"transaction_type\": \"AUTHORIZATION\",\n \"voided_amount\": 500,\n \"created_datetime\": \"2025-10-09T08:56\",\n \"voided_datetime\": \"2025-10-09T08:58:51.020512\",\n \"requested_amount\": 500,\n \"cvv_response\": \"M\",\n \"avs_response\": \"A\",\n \"captured_datetime\": \"2025-10-09T08:57:32\",\n \"captured_amount\": 0,\n \"authorized_amount\": 0,\n \"status\": \"VOIDED\"\n}"},{"id":"2450e8f2-6a46-44a4-b58a-88bdbe09cf20","name":"Error","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"type\" : \"card\",\n \"transaction_uuid\" : \"6727a7c7-a956-431e-85fa-b3e1b5aade65\"\n}","options":{"raw":{"language":"json"}}},"url":"/transaction/void"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Thu, 09 Oct 2025 12:59:45 GMT"},{"key":"Server","value":"HighWireGateway-1.0.0"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"81"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Transaction is in BATCHED status and can not be voided, please refund\"\n}"}],"_postman_id":"30defa75-9fc0-4bf7-9548-075c927a5f39"},{"name":"Capture Card","id":"8cd37179-09cc-4009-a685-afd6d9dce0b8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"type\" : \"card\",\n \"transaction_uuid\" : \"6727a7c7-a956-431e-85fa-b3e1b5aade65\"\n}","options":{"raw":{"language":"json"}}},"url":"/transaction/capture","description":"A transaction can only be captured when it is in the AUTHORIZED state
\n","urlObject":{"path":["transaction","capture"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"f2753a15-5bd5-41e4-b044-4ac512df9fad","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"type\" : \"card\",\n \"transaction_uuid\" : \"f3817adc-1894-4ca7-9e26-89d173c8d485\"\n}","options":{"raw":{"language":"json"}}},"url":"/transaction/capture"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Thu, 09 Oct 2025 12:57:32 GMT"},{"key":"Server","value":"HighWireGateway-1.0.0"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"432"}],"cookie":[],"responseTime":null,"body":"{\n \"authorized_datetime\": \"2025-10-09T08:56:06\",\n \"response_code\": \"0000\",\n \"transaction_uuid\": \"f3817adc-1894-4ca7-9e26-89d173c8d485\",\n \"authorization_response_code\": \"PAYPAL\",\n \"transaction_type\": \"AUTHORIZATION\",\n \"voided_amount\": 0,\n \"created_datetime\": \"2025-10-09T08:56\",\n \"requested_amount\": 500,\n \"cvv_response\": \"M\",\n \"avs_response\": \"A\",\n \"captured_datetime\": \"2025-10-09T08:57:32.476964\",\n \"captured_amount\": 500,\n \"authorized_amount\": 500,\n \"status\": \"CAPTURED\"\n}"},{"id":"dfb52e09-8ddc-4ad4-9604-b45505b9b3a7","name":"Error","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"type\" : \"card\",\n \"transaction_uuid\" : \"6727a7c7-a956-431e-85fa-b3e1b5aade65\"\n}","options":{"raw":{"language":"json"}}},"url":"/transaction/capture"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Thu, 09 Oct 2025 12:58:18 GMT"},{"key":"Server","value":"HighWireGateway-1.0.0"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"69"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Transaction is in DECLINED status and can not be captured\"\n}"}],"_postman_id":"8cd37179-09cc-4009-a685-afd6d9dce0b8"},{"name":"Refund Card","id":"5a6142eb-271f-4d0c-b418-8d9fc900392c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"type\" : \"card\",\n \"transaction_uuid\" : \"48120a16-5edd-4f22-910a-ffa45f871d5c\",\n \"refund_amount\": 12345\n}","options":{"raw":{"language":"json"}}},"url":"/transaction/refund","description":"A transaction can only be REFUNDED once it is in the batch state.
\nA refund_amount value may be provided that will only refund part of the transaction. If this value is ommited, a full refund will be issued. The sum of partial refunds can not exceed the original transaction amount.