=============== LIBRARY RULES =============== From library maintainers: - Always use Bearer Token authentication in the Authorization header - All API requests must be made over HTTPS - Include terminal.id in all payment requests - Use card.save=Yes during sale/auth to auto-tokenize cards - Use POST /payment/generate-token for standalone tokenization - Use Hosted Fields for PCI-compliant client-side card entry - Sandbox base URL: https://sandbox-gateway.maverickpayments.com - Production base URL: https://gateway.maverickpayments.com ### POST Sale Request Example Source: https://github.com/mkovnick/maverick-payments-api-docs/blob/main/card-payments.md This is an example of a POST request to initiate a sale transaction. It includes card details, contact information, and address verification. ```json { "source": "Internet", "level": 1, "card": { "name": "John Wick", "number": 5309572686772257, "exp": "12/30", "cvv": 998, "address": { "country": "United State of America", "state": "CA", "city": "Calabasas", "street": "8320", "zip": "85284" } }, "contact": { "email": "test@testemail.com" }, "sendReceipt": "Yes" } ``` -------------------------------- ### POST Sale Request Example Source: https://github.com/mkovnick/maverick-payments-api-docs/blob/main/card-payments.md This is an example of a POST Sale request payload. Ensure all required fields are populated according to the API documentation. ```json { "terminal": { "id": 24 }, "amount": "2.10", ``` -------------------------------- ### Webhook Event Example Source: https://github.com/mkovnick/maverick-payments-api-docs/blob/main/reporting.md An example of a webhook event object, including its ID, module, action, date, and associated data. ```json { "id": "1", "module": "ach", "action": "create", "date": "2019-08-03 19:31:55", "data": {...} } ``` -------------------------------- ### Response: List with Date Range Source: https://github.com/mkovnick/maverick-payments-api-docs/blob/main/platforms.md Example JSON response for a GET Payouts request filtered by a date range. Includes details on processing date, deposit amounts, fees, chargebacks, and batch information. ```json { "items": [ { "processingDate": "2023-04-12", "deposit": 9731.14, "feeTotalAmount": 0, "chargeback": { "totalCount": 0, "totalAmount": 0 }, "reservedAmount": 0, "releasedAmount": 0, "batches": { "date": "2023-04-12", "amount": "9731.14", "sequence": "391" } }, { "processingDate": "2023-04-11", "deposit": 11717.87, "feeTotalAmount": 0, "chargeback": { "totalCount": 0, "totalAmount": 0 }, "reservedAmount": 0, "releasedAmount": 0, "batches": { "date": "2023-04-11", "amount": "11717.87", "sequence": "391" } }, { "processingDate": "2023-04-10", "deposit": 10473.83, "feeTotalAmount": 0, "chargeback": { "totalCount": 0, "totalAmount": 0 }, "reservedAmount": 0, "releasedAmount": 0, "batches": { "date": "2023-04-10", "amount": "10473.83", "sequence": "391" } }, { "processingDate": "2023-04-09", "deposit": 5779.3, "feeTotalAmount": 0, "chargeback": { "totalCount": 0, "totalAmount": 0 }, "reservedAmount": 0, "releasedAmount": 0, "batches": { "date": "2023-04-09", "amount": "8881.54", "sequence": "391" } }, { "processingDate": "2023-04-07", "deposit": 10971.79, "feeTotalAmount": 0, "chargeback": { "totalCount": 0, "totalAmount": 0 }, "reservedAmount": 0, "releasedAmount": 0, "batches": { "date": "2023-04-07", "amount": "10971.79", "sequence": "391" } }, { "processingDate": "2023-04-06", "deposit": 12333.28, "feeTotalAmount": 0, "chargeback": { "totalCount": 0, "totalAmount": 0 }, "reservedAmount": 0, "releasedAmount": 0, "batches": { "date": "2023-04-06", "amount": "12333.28", "sequence": "391" } }, { "processingDate": "2023-04-05", "deposit": 13538.1, "feeTotalAmount": 0, "chargeback": { "totalCount": 0, "totalAmount": 0 }, "reservedAmount": 0, "releasedAmount": 0, "batches": { "date": "2023-04-05", "amount": "13538.10", "sequence": "391" } }, { "processingDate": "2023-04-04", "deposit": 15223, "feeTotalAmount": 0, "chargeback": { "totalCount": 0, "totalAmount": 0 }, "reservedAmount": 0, "releasedAmount": 0, "batches": { "date": "2023-04-04", "amount": "15223.00", "sequence": "391" } }, { "processingDate": "2023-04-03", "deposit": 18818.1, "feeTotalAmount": 0, "chargeback": { "totalCount": 0, "totalAmount": 0 }, "reservedAmount": 0, "releasedAmount": 0, "batches": { "date": "2023-04-03", "amount": "18818.10", "sequence": "391" } }, { "processingDate": "2023-04-02", "deposit": 17091.86, "feeTotalAmount": 0, "chargeback": { "totalCount": 0, "totalAmount": 0 }, "reservedAmount": 0, "releasedAmount": 0, "batches": { "date": "2023-04-02", "amount": "27719.63", "sequence": "391" } } ], "_links": { "self": { "href": "https://dashboard.maverickpayments.com/api/reporting/payouts/acq/9?filter%5BprocessingDate%5D%5Bgte%5D=2023-04-01&filter%5BprocessingDate%5D%5Blte%5D=2023-04-30&page=1" }, "first": { "href": "https://dashboard.maverickpayments.com/api/reporting/payouts/acq/9?filter%5BprocessingDate%5D%5Bgte%5D=2023-04-01&filter%5BprocessingDate%5D%5Blte%5D=2023-04-30&page=1" }, "last": { "href": "https://dashboard.maverickpayments.com/api/reporting/payouts/acq/9?filter%5BprocessingDate%5D%5Bgte%5D=2023-04-01&filter%5BprocessingDate%5D%5Blte%5D=2023-04-30&page=1" } }, "_meta": { "totalCount": 10, "pageCount": 1, "currentPage": 1, "perPage": 30 } } ``` -------------------------------- ### Batch Summary Response Example Source: https://github.com/mkovnick/maverick-payments-api-docs/blob/main/reporting.md Example JSON response for the batch summary endpoint. Includes total debit and credit amounts, date, sequence, split funding, and overall amount. ```json { "debit": "148.16", "credit": "-48.00", "date": "2020-03-22", "sequence": "391", "splitFunding": "12.2", "amount": 100.16, "id": "r8nV0N" } ``` -------------------------------- ### GET List DBAs Source: https://github.com/mkovnick/maverick-payments-api-docs/blob/main/platforms.md Use this endpoint to list all DBAs available for your account. The response includes detailed information about each DBA's processing and ACH setup. ```json { "items": [ { "id": "1", "name": "Demo Merchant DBA", "address": { "street": "Lorem 15", "city": "New Damonmouth", "zip": "2222", "state": [ 15 ], "country": [ 199 ] }, "customerServiceContact": { "phone": "+1 717-888-8888", "email": "demo-example@example.org" }, "mcc": "5734", "processing": { "id": "590", "mid": 201143806445, "bank": { "accountNumber": "123456789", "routingNumber": "12345678" }, "banks": [ { "id": 280, "type": "All", "bankAccountNumber": "123456789", "bankRoutingNumber": "12345678" } ], "riskLevel": "LowEligible", "status": "Closed", "boardedOn": "2019-02-06 12:00:00", "closedOn": "2022-02-16 15:38:33", "volumes": { "monthlyTransactionAmount": 7000000, "avgTransactionAmount": 700, "maxTransactionAmount": 7000 }, "sales": { "swiped": 30, "mail": 10, "internet": 60 }, "feeSchedule": { "fees": [ { "id": "1", "type": { "id": "1" }, "value": "0.00000" }, { "id": "2", "type": { "id": "2" }, "value": "0.00000" }, { "id": "3", "type": { "id": "3" }, "value": "0.00000" }, { "id": "4", "type": { "id": "4" }, "value": "0.00000" }, { "id": "5", "type": { "id": "5" }, "value": "0.00000" }, { "id": "6", "type": { "id": "6" }, "value": "0.00000" }, { "id": "7", "type": { "id": "7" }, "value": "0.75000" }, { "id": "8", "type": { "id": "8" }, "value": "0.00000" }, { "id": "9", "type": { "id": "9" }, "value": "0.00000" }, { "id": "10", "type": { "id": "10" }, "value": "0.00000" }, { "id": "11", "type": { "id": "11" }, "value": "5.00000" }, { "id": "12", "type": { "id": "12" }, "value": "25.00000" }, { "id": "13", "type": { "id": "13" }, "value": "0.00000" }, { "id": "14", "type": { "id": "14" }, "value": "0.00000" }, { "id": "15", "type": { "id": "15" }, "value": "0.05000" }, { "id": "16", "type": { "id": "16" }, "value": "35.00000" }, { "id": "17", "type": { "id": "17" }, "value": "5.00000" }, { "id": "18", "type": { "id": "18" }, "value": "0.00000" }, { "id": "19", "type": { "id": "20" }, "value": "0.00000" }, { "id": "20", "type": { "id": "18" }, "value": "0.00000" }, { "id": "21", "type": { "id": "18" }, "value": "0.00000" } ], "note": null } }, "ach": { "id": "14", "bank": { "accountNumber": "123456789", "routingNumber": "12345678" }, "banks": [ { "id": 200, "type": "All" } ] } } ] } ``` -------------------------------- ### Example Level 3 Request Source: https://github.com/mkovnick/maverick-payments-api-docs/blob/main/card-payments.md An example of a Level 3 sale request, which includes detailed order information such as tax, discount, and shipping. ```APIDOC ## POST Sale (Level 3 Example) ### Description An example of a Level 3 sale request, including detailed order information. ### Method POST ### Endpoint /sale ### Request Body - **id** (integer) - Optional - Identifier for the transaction. - **amount** (string) - Required - The transaction amount. - **origin** (string) - Optional - The origin of the transaction (e.g., "API"). - **type** (string) - Required - The type of transaction (e.g., "Auth"). - **level** (integer) - Required - The level of detail for the transaction (e.g., 3). - **authCode** (string) - Optional - Authorization code. - **parent** (object) - Optional - Information about the parent transaction. - **terminal** (object) - Required - Terminal information. - **id** (integer) - Required - Terminal identifier. - **threeds** (object) - Optional - 3D Secure information. - **id** (string) - Optional - 3D Secure transaction ID. - **eci** (string) - Optional - Electronic Commerce Indicator. - **aav** (string) - Optional - Address Verification Authentication Value. - **cavv** (string) - Optional - Cardholder Authentication Verification Value. - **card** (object) - Required - Cardholder information. - **bin** (integer) - Required - Bank Identification Number. - **name** (string) - Required - Cardholder's name. - **number** (integer) - Required - Card number (can be partial). - **exp** (string) - Required - Card expiration date (YYYY-MM-DD). - **verification** (object) - Required - Verification results. - **cvv** (string) - Required - CVV match status. - **address** (string) - Required - Address verification status. - **networkTransactionId** (string) - Optional - Network transaction identifier. - **contact** (object) - Required - Contact information. - **name** (string) - Optional - Contact person's name. - **phone** (string) - Optional - Contact person's phone number. - **email** (string) - Required - Contact person's email address. - **externalId** (string) - Optional - External transaction identifier. - **isRecurring** (string) - Optional - Indicates if the transaction is recurring. - **split** (object) - Optional - Split transaction details. - **refunded** (boolean) - Optional - Indicates if the transaction has been refunded. - **captured** (boolean) - Optional - Indicates if the transaction has been captured. - **history** (array) - Optional - Transaction history. - **order** (object) - Optional - Order details. - **id** (string) - Optional - Order identifier. - **date** (string) - Optional - Order date. - **invoice** (string) - Optional - Invoice number. - **description** (string) - Optional - Order description. - **note** (string) - Optional - Order notes. - **summaryCommodityCode** (string) - Optional - Summary commodity code. - **supplierRefNo** (string) - Optional - Supplier reference number. - **tax** (object) - Optional - Tax details. - **amount** (string) - Optional - Total tax amount. - **details** (array) - Optional - Array of tax detail objects. - **type** (string) - Optional - Tax type. - **amount** (string) - Optional - Tax amount. - **rate** (string) - Optional - Tax rate. - **category** (string) - Optional - Tax category. - **discount** (object) - Optional - Discount details. - **amount** (string) - Optional - Discount amount. - **customer** (object) - Optional - Customer details. - **id** (string) - Optional - Customer ID. - **vat** (string) - Optional - Customer VAT number. - **shipping** (object) - Optional - Shipping details. - **fromZip** (string) - Optional - Originating postal code. - **toZip** (string) - Optional - Destination postal code. - **toCountry** (string) - Optional - Destination country. - **cost** (string) - Optional - Shipping cost. - **dutyCost** (string) - Optional - Shipping duty cost. - **feeTransaction** (object) - Optional - Fee transaction details. - **batch** (object) - Optional - Batch processing information. - **ip** (object) - Optional - IP address information. - **address** (string) - Optional - IP address. - **isp** (string) - Optional - Internet Service Provider. - **type** (string) - Optional - IP address type. - **location** (object) - Optional - IP location details. - **city** (string) - Optional - City. - **state** (string) - Optional - State/Province. - **country** (string) - Optional - Country. - **zip** (string) - Optional - Postal code. - **info** (object) - Optional - Additional IP information. - **isAnonymous** (string) - Optional - Indicates if the IP is anonymous. - **isAnonymousVpn** (string) - Optional - Indicates if the IP is an anonymous VPN. - **isPublicProxy** (string) - Optional - Indicates if the IP is a public proxy. - **isHostingProvider** (string) - Optional - Indicates if the IP belongs to a hosting provider. - **isTorExitNode** (string) - Optional - Indicates if the IP is a Tor exit node. - **status** (object) - Optional - Transaction status. - **status** (string) - Optional - The status of the transaction (e.g., "Approved"). - **reason** (string) - Optional - Reason for the status. - **updatedOn** (string) - Optional - Timestamp of the last update. - **createdOn** (string) - Optional - Timestamp of creation. ### Request Example ```json { "id": 206, "amount": "1.10", "origin": "API", "type": "Auth", "level": 3, "authCode": "TAS054", "parent": { "id": null }, "terminal": { "id": 481771 }, "threeds": { "id": null, "eci": null, "aav": null, "cavv": null }, "card": { "bin": 453922, "name": "John Doe", "number": 4489, "exp": "2030-12-31", "verification": { "cvv": "M", "address": "Y" }, "networkTransactionId": "000000000007903" }, "contact": { "name": "John Doe", "phone": "800-888-8888", "email": "jdoe@test.com" }, "externalId": null, "isRecurring": "No", "split": null, "refunded": false, "captured": true, "history": [ { "id": 207, "type": "Capture", "amount": "1.10", "createdOn": "2025-05-16 06:59:04" } ], "order": { "id": "00001", "date": "2023-06-08", "invoice": "INV001", "description": "Order Description", "note": null, "summaryCommodityCode": "1A b", "supplierRefNo": "SRN101", "tax": { "amount": "0.01", "details": [ { "type": "Sales", "amount": "0.01", "rate": "10.00", "category": "VAT" } ] }, "discount": { "amount": "0.05" }, "customer": { "id": "Customer101", "vat": "Customer VAT" }, "shipping": { "fromZip": "91770", "toZip": "90004", "toCountry": "USA", "cost": "0.01", "dutyCost": "0.01" } }, "feeTransaction": null, "batch": { "id": null, "number": null, "batchedOn": null }, "ip": { "address": "123.123.123.123", "isp": "China Unicom", "type": "residential", "location": { "city": "Beijing", "state": "BJ", "country": "CN", "zip": null }, "info": { "isAnonymous": "No", "isAnonymousVpn": "No", "isPublicProxy": "No", "isHostingProvider": "No", "isTorExitNode": "No" } }, "status": { "status": "Approved", "reason": null }, "updatedOn": "2025-05-16 06:59:05", "createdOn": "2025-05-16 06:59:02" } ``` ``` -------------------------------- ### Approval Response Example Source: https://github.com/mkovnick/maverick-payments-api-docs/blob/main/response-codes.md This is an example of a successful approval response. It only contains a status field and no reason. ```json { "status": { "status": "Approved", "reason": null } } ``` -------------------------------- ### Example Billing Object Source: https://github.com/mkovnick/maverick-payments-api-docs/blob/main/reporting.md Use this structure to provide billing information under the `order.billing` field. ```json { "name": "Craig Dewayne", "country": "United States", "state": "Arkansas", "city": "Pea Ridge", "street": "1302 Spruce St", "zip": "72751" } ``` -------------------------------- ### Example Shipping Object Source: https://github.com/mkovnick/maverick-payments-api-docs/blob/main/reporting.md Use this structure to provide shipping information under the `order.shipping` field. ```json { "toCountry": "United States", "toCity": "Pea Ridge", "toAddress": "1302 Spruce St", "toZip": "72751", "fromZip": "31151" } ``` -------------------------------- ### GET Overview Source: https://github.com/mkovnick/maverick-payments-api-docs/blob/main/platforms.md Retrieves an overview of batches for a specific date. ```APIDOC ## GET Overview ### Description Retrieves an overview of batches for a specific date. ### Method GET ### Endpoint `https://dashboard.maverickpayments.com/api/reporting/batch-overview/` ### Parameters #### Path Parameters - **batch.date** (string) - Required - The date for which to retrieve the batch overview (YYYY-MM-DD). ### Response #### Success Response (200) - **items** (array) - A list of batch overview objects. - **id** (string) - The overview ID. - **dba** (object) - DBA details. - **id** (integer) - The DBA ID. - **mid** (integer) - The Merchant ID. - **debit** (number) - Total debit amount for the batch. - **credit** (number) - Total credit amount for the batch. - **amount** (number) - The net amount for the batch. - **date** (string) - The date of the batch. - **sequence** (integer) - The sequence number of the batch. - **splitFunding** (number) - The split funding amount. - **_links** (object) - Links for pagination. - **_meta** (object) - Metadata about the response. - **totalCount** (integer) - Total number of items. - **pageCount** (integer) - Total number of pages. - **currentPage** (integer) - The current page number. - **perPage** (integer) - Number of items per page. #### Response Example ```json { "items": [ { "id": "baOREx", "dba": { "id": 4695 }, "mid": 30110000001, "debit": 420, "credit": 0, "amount": 420, "date": "2025-12-01", "sequence": 298, "splitFunding": 0 }, { "id": "baOREx", "dba": { "id": 5205 }, "mid": 30110000001, "debit": 136807.17, "credit": -31444.75, "amount": 105362.42, "date": "2025-12-01", "sequence": 670, "splitFunding": 0 }, { "id": "baOREx", "dba": { "id": 6867 }, "mid": 30110000001, "debit": 1425, "credit": -75, "amount": 1350, "date": "2025-12-01", "sequence": 621, "splitFunding": 0 } ], "_links": { "self": { "href": "https://dashboard.maverickpayments.com/api/reporting/batch-overview/2025-12-01?page=1" } }, "_meta": { "totalCount": 3, "pageCount": 1, "currentPage": 1, "perPage": 30 } } ``` ``` -------------------------------- ### Batch List Response Example Source: https://github.com/mkovnick/maverick-payments-api-docs/blob/main/reporting.md Example JSON response when listing transactions within a batch with applied filters. Includes transaction details, card information, and batch data. ```json { "items": [ { "id": "17385312", "card": { "number": "531259XXXXXX0736", "bin": { "bin": "531259", "brand": "Mastercard", "organization": "Bank Of America, National Association", "type": "Debit", "category": "Enhanced", "country": { "name": "United States", "code": "US" } } }, "amount": -0.01, "adjustment": 0, "type": "credit", "purchaseId": "SSS-2023032405742994", "terminal": { "vNumber": null, "id": null, "number": null }, "batch": { "id": "xxxxxxx", "date": "2020-03-22", "sequence": "445" }, "reject": { "code": "0238", "description": "Excessive transaction amount" }, "date": "2020-03-22" }, { "id": "17385309", "card": { "number": "483312XXXXXX8992", "bin": { "bin": "483312", "brand": "Visa", "organization": "Jpmorgan Chase Bank, N.a.", "type": "Debit", "category": "Classic", "country": { "name": "United States", "code": "US" } } }, "amount": -0.11, "adjustment": 0, "type": "credit", "purchaseId": "SSS-54552405742994", "terminal": { "vNumber": null, "id": null, "number": null }, "batch": { "id": "xxxxxxx", "date": "2020-03-22", "sequence": "446" }, "reject": { "code": "0238", "description": "Excessive transaction amount" }, "date": "2020-03-22" } ], "_links": { "self": { "href": "https://dashboard.maverickpayments.com/api/reporting/batches/14?page=1" } }, "_meta": { "totalCount": 2, "pageCount": 1, "currentPage": 1, "perPage": 30 } } ``` -------------------------------- ### Example Tax Object Source: https://github.com/mkovnick/maverick-payments-api-docs/blob/main/reporting.md Use this structure when submitting a list of taxes within the `order.taxses` field. ```json { "type": "VAT", "amount": "2.40", "rate": "10.00", "category": "VAT" } ``` -------------------------------- ### Example Product Object Source: https://github.com/mkovnick/maverick-payments-api-docs/blob/main/reporting.md Use this structure when submitting a list of products within the `order.products` field. ```json { "name": "Hosting", "price": "24.00", "quantity": "1.00" } ``` -------------------------------- ### GET List of Authorizations with Filters Source: https://github.com/mkovnick/maverick-payments-api-docs/blob/main/reporting.md Retrieve a filtered list of authorizations by card brand, terminal number, and a date range. The example demonstrates filtering for Visa card authorizations from a specific terminal within a 24-hour period. ```json { "id": "22375683", "card": { "number": "443048XXXXXX5662", "bin": { "bin": "443048", "brand": "Visa", "organization": "Pnc Bank, N.a.", "type": "Debit", "category": "Classic", "country": { "name": "United States", "code": "US" } } }, "amount": "0.01", "type": "Credit", "terminal": { "id": "14", "number": 7000 }, "date": "2020-03-24 00:31:25", "status": "Successful approval/completion" }, { "id": "22375518", "card": { "number": "453825XXXXXX9026", "bin": { "bin": "453825", "brand": "Visa", "organization": "Bank Of Nova Scotia", "type": "Credit", "category": "Business", "country": { "name": "Canada", "code": "CA" } } }, "amount": "0.01", "type": "Credit", "terminal": { "id": "14", "number": 7000 }, "date": "2020-03-24 00:50:42", "status": "Successful approval/completion" } ], "_links": { "self": { "href": "https://dashboard.maverickpayments.com/api/reporting/authorizations/1?filter%5Bcard.bin.brand%5D=Visa&filter%5Bterminal.number%5D=7000&filter%5Bdate%5D%5Bgte%5D=2020-03-24+00%3A00%3A00&filter%5Bdate%5D%5Blte%5D=2020-03-24+23%3A59%3A59&page=1" } }, "_meta": { "totalCount": 2, "pageCount": 1, "currentPage": 1, "perPage": 30 } } ``` -------------------------------- ### Create a monthly recurring payment Source: https://context7.com/mkovnick/maverick-payments-api-docs/llms.txt Set up an automatic monthly subscription for a customer. This requires the customer's ID and card ID, along with payment details and a valid date range. ```bash curl -X POST https://dashboard.maverickpayments.com/api/customer-vault/42/recurring-payment \ -H "Authorization: Bearer YOUR_API_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "name": "Monthly SaaS Subscription", "description": "Pro Plan", "amount": 49.99, "execute": { "frequency": 1, "period": "month" }, "valid": { "from": "2025-01-01", "to": "2026-01-01" }, "payment": { "max": 12 }, "terminal": { "id": 24 }, "customer": { "id": 42, "card": { "id": 5 } }, "dba": { "id": 1 } }' ``` -------------------------------- ### Embeded E-sign Example Flow 1 Source: https://github.com/mkovnick/maverick-payments-api-docs/blob/main/platforms.md This flow demonstrates how to initiate the popup module for e-signing and handle a redirect callback upon successful signing. ```APIDOC ## Embeded E-sign Example Flow 1 ### Description Initiates the popup module for e-signing and performs a callback function with a redirect once the application is signed. ### Script ```html ``` ### JavaScript ```javascript function signFunction() { let boardingApplicationSignature = new BoardingApplicationSignature; boardingApplicationSignature.open({ "id": 10, "token": "130bb9ce-2151-4e01-8952-52e815c6d444", "domain": "dashboard.example.com" }, function(data) { window.location="https:\/\/example.com?data="+JSON.stringify(data); }) } ``` ### HTML Button ```html ``` ### Redirect Examples **Success:** `https://example.com?data={"event":"sign","boardingApplication":{"id":1},"principal":{"id":1,"name":{"first":"Test","last":"Test"}},"sign":{"id":9,"status":"Signed"}}` **Validation Errors:** `https://www.example.com/?data={"event":"exception","name":"Bad%20Request","message":"The%20requested%20Boarding%20Application%20Signing%20Request%20has%20been%20rejected.","code":400,"status":400}` ``` -------------------------------- ### List Transactions Response Example Source: https://github.com/mkovnick/maverick-payments-api-docs/blob/main/transaction-reporting.md This is an example of the JSON response structure when listing transactions. It includes details for each transaction, such as ID, amount, origin, status, and card information. ```json { "items": [ { "id": 863, "amount": "2.00", "origin": "HostedForm", "type": "Auth", "level": 1, "authCode": "TAS364", "parent": { "id": null }, "terminal": { "id": 24 }, "threeds": { "id": 39 }, "card": { "bin": 411111, "name": "test test", "number": 1111, "exp": "2024-11-30", "verification": { "cvv": "M", "address": "N" }, "networkTransactionId": "000000000173444" }, "contact": { "name": "", "phone": "", "email": "" }, "externalId": null, "isRecurring": "No", "split": null, "refunded": true, "captured": false, "history": [], "order": null, "feeTransaction": null, "batch": { "id": null, "number": null, "batchedOn": null }, "ip": { "address": "50.17.187.84", "isp": "Amazon.com", "type": "hosting", "location": { "city": "Ashburn", "state": "VA", "country": "US", "zip": "20149" }, "info": { "isAnonymous": "Yes", "isAnonymousVpn": "No", "isPublicProxy": "No", "isHostingProvider": "Yes", "isTorExitNode": "No" } }, "status": { "status": "Decline", "reason": "Transaction rejected due to: AVS Zip Mismatch, AVS Address Mismatch" }, "updatedOn": "2023-04-25 14:46:07", "createdOn": "2023-04-25 14:46:07" }, { "id": 862, "amount": "2.00", "origin": "HostedForm", "type": "Capture", "level": 1, "authCode": null, "parent": { "id": 861 }, "terminal": { "id": 24 }, "threeds": { "id": null }, "card": { "bin": 401200, "name": null, "number": 26, "exp": "2033-11-30", "verification": { "cvv": null, "address": null }, "networkTransactionId": null }, "contact": null, "externalId": null, "isRecurring": "No", "split": null, "refunded": false, "captured": false, "history": [], "order": null, "feeTransaction": null, "batch": { ``` -------------------------------- ### View Equipment Settings Source: https://github.com/mkovnick/maverick-payments-api-docs/blob/main/platforms.md Use this endpoint to view the equipment settings on a Boarding Application. ```APIDOC ## GET View Equipment Settings ### Description Use this endpoint to view the equipment settings on a Boarding Application. ### Method GET ### Endpoint `https://dashboard.maverickpayments.com/api/boarding-application//equipment` ### Response #### Success Response (200) - **equipment** (Object) - Equipment details including used status, notes, and provider. - **varRequired** (Object) - Indicates if variable is required. - **discountPeriod** (Object) - The period for discounts. - **fundingPeriod** (Object) - The period for funding. - **type** (Object) - The type of equipment setting. - **emv** (Object) - EMV settings. - **mobileTerminal** (Object) - Mobile terminal settings. - **externalPinPad** (Object) - External pin pad settings. - **contactless** (Object) - Contactless payment settings. - **existingTID** (Object) - Information about existing TIDs, including a list of terminals. - **serialNumberSettings** (Object) - Serial number settings. - **pinDebitPad** (Object) - PIN debit pad settings. - **ebtFnsNumber** (Object) - EBT FNS number settings. - **terminal** (Object) - Detailed terminal configuration including paid by, amount, shipping, communication, batch, header, footer, surcharge, and tip settings. - **lastEquipmentUpdated** (String) - Timestamp of the last equipment update. - **lastAgentReview** (String) - Timestamp of the last agent review. ### Response Example ```json { "equipment": { "used": { "value": "", "locked": "No" }, "note": { "value": "", "locked": "No" }, "providedBy": { "value": null, "locked": "No" } }, "varRequired": { "value": "No", "locked": "No" }, "discountPeriod": { "value": "Daily", "locked": "No" }, "fundingPeriod": { "value": "TwoBusinessDays", "locked": "No" }, "type": { "value": "StageOnly", "locked": "No" }, "emv": { "value": null, "locked": "No" }, "mobileTerminal": { "value": null, "locked": "No" }, "externalPinPad": { "value": null, "locked": "No" }, "contactless": { "value": null, "locked": "No" }, "existingTID": { "value": "No", "locked": "No", "terminals": [ { "tid": 7000, "vNumber": null, "gateway": "Other", "note": null } ] }, "serialNumberSettings": { "value": null, "locked": "No" }, "pinDebitPad": { "value": null, "locked": "No" }, "ebtFnsNumber": { "value": null, "locked": "No" }, "terminal": { "paidBy": { "value": null, "locked": "No" }, "paidAmount": { "value": null, "locked": "No" }, "shipTo": { "value": null, "locked": "No" }, "shipping": { "address": { "value": "", "locked": "No" }, "method": { "value": null, "locked": "No" } }, "communication": { "value": null, "locked": "No" }, "batch": { "type": { "value": null, "locked": "No" }, "period": { "value": "", "locked": "No" } }, "header": { "value": "", "locked": "No" }, "footerLine": { "value": null, "locked": "No" }, "surcharge": { "feeDescription": { "value": "", "locked": "No" }, "percentage": { "value": null, "locked": "No" }, "bypassOption": { "value": null, "locked": "No" }, "notes": { "value": "", "locked": "No" } }, "tip": { "line": { "value": "No", "locked": "No" }, "prompt": { "value": "No", "locked": "No" }, "suggestion": { "value": "No", "locked": "No", "percentages": { "value": "", "locked": "No" } } } }, "lastEquipmentUpdated": "2023-05-11 13:19:41", "lastAgentReview": null } ``` ```