openapi: 3.0.0 paths: /v1/public/ach/charge: post: description: >- Initiate an ACH bank transfer charge. A payment can be made using raw ACH account data or for an existing customer vault. If charging a customer vault, the `billingAddress` and `achData` fields are not required — the vault's default payment method is used. **Dual-pricing accounts:** `amount` represents the cash price; a discount is applied based on the configured discount rate. **`achData.accountType` values:** `businessChecking`, `businessSavings`, `personalChecking`, `personalSavings`. **`achData.last4`** must be the last 4 digits of the account number (regex: `\d{4}`). operationId: achCharge parameters: - name: user-agent required: true in: header schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AchChargePublicDto' examples: example1: summary: Charge value: amount: EXAMPLE contact: email: EXAMPLE phone: EXAMPLE billingAddress: firstName: demo lastName: demo address: demo city: demo country: US phoneNumber: EXAMPLE state: Alaska zipCode: EXAMPLE shippingAddress: {} order: amount: EXAMPLE shipping: 0 tax: 0 poNumber: '65614' discount: 0 capture: true achData: accountType: personalChecking accountNumber: '999999' routingNumber: '490000018' firstName: EXAMPLE lastName: EXAMPLE last4: '9999' driverLicenseNumber: '765755' phoneNumber: '1234567890' sendReceipt: false paymentType: ach responses: '201': description: ACH charge created. content: application/json: examples: example1: summary: ACH Charge value: data: object: charge type: sale amount: 750 baseAmount: 750 currency: USD captured: true transactionId: 1000004722 error: false createdAt: '2024-04-09T17:15:58.630Z' transactionAt: '2024-04-09T17:15:58.630Z' settled: false userAgent: PostmanRuntime/7.37.3 device: api paymentId: 661577d05e0564787bfac8c5 createdBy: integration@strictlyzero.com updatedBy: integration@strictlyzero.com surcharge: 0 cardFee: 0 example2: summary: ACH Charge with taxes value: data: object: charge type: sale amount: 106 baseAmount: 106 currency: USD captured: true transactionId: 1000024056 error: false createdAt: '2025-08-05T16:49:30.121Z' transactionAt: '2025-08-05T16:49:30.121Z' settled: false userAgent: PostmanRuntime/7.45.0 device: api paymentId: 6892361a9d9fe222940bb8e3 createdBy: emilio.ruiz@samsystems.io updatedBy: emilio.ruiz@samsystems.io surcharge: 0 tax: 6 '400': description: Bad Request '401': description: Unauthorized security: - bearer: [] summary: ACH charge tags: - ACH /v1/public/ach/refund: post: description: >- Post a refund on a previously created ACH payment. Funds are returned to the original bank account. **Important:** There is a mandatory delay of 3–6 minutes between the original transaction and when a refund can be processed. ACH refunds must be for the **exact amount** of the original transaction — partial refunds are not allowed. A refund on a fully refunded payment will result in an error. `amount` is expressed in cents (e.g. 100 = $1.00). `reason` is free text and is required. operationId: achRefund parameters: - name: user-agent required: true in: header schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RefundPublicDto' examples: example1: summary: ACH Refund value: paymentId: 636d7a6f1c76f985388bc49d amount: 5 reason: Test responses: '200': description: Refund processed. '400': description: Bad Request — partial refund attempted, delay not met, or payment already refunded. '401': description: Unauthorized security: - bearer: [] summary: ACH refund tags: - ACH /v1/public/ach/void: post: description: >- Void an existing ACH payment that has not yet been settled. Once voided, no additional charges can be made. **`reason` values (ACH-specific):** `fraud`, `user_cancel`, `icc_rejected`, `insufficient_funds`, `incorrect_information`, `pos_timeout`. Set `receipt=true` to send a receipt notification to the customer via email or SMS. operationId: achVoid parameters: - name: user-agent required: true in: header schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/VoidPublicDto' examples: example1: summary: Void value: paymentId: EXAMPLE reason: user_cancel receipt: true responses: '200': description: Payment voided. '400': description: Bad Request — payment already settled or invalid reason. '401': description: Unauthorized security: - bearer: [] summary: ACH void tags: - ACH /v1/public/ach: get: description: >- Returns a paginated list of ACH payments. Filter by date range, last 4 digits of the account number, or authorization number. operationId: listAchPayments parameters: - name: authorizationNumber required: false in: query schema: type: string description: Authorization/reference number from the ACH processor - name: achLast4 required: false in: query schema: type: string description: Last 4 digits of the bank account number - name: endDay required: false in: query schema: type: string format: date description: Filter end date (YYYY-MM-DD) - name: startDay required: false in: query schema: type: string format: date description: Filter start date (YYYY-MM-DD) - name: limit required: false in: query schema: type: integer minimum: 1 maximum: 100 default: 25 description: 'Items per page (default: 25)' - name: page required: false in: query schema: type: integer minimum: 1 default: 1 description: 'Page number (default: 1)' responses: '200': description: Paginated ACH payments list. content: application/json: schema: type: object properties: data: type: array items: type: object total: type: integer page: type: integer limit: type: integer '401': description: Unauthorized security: - bearer: [] summary: List ACH payments tags: - ACH /v1/public/customer: get: description: Returns a paginated list of customer vaults for the authenticated merchant. operationId: listCustomers parameters: - name: page required: false in: query description: Page number for paginating schema: type: number - name: limit required: false in: query description: Limit items per page schema: type: number responses: '200': description: Paginated customers list. content: application/json: examples: example1: summary: List Customer value: meta: count: 1 totalPages: 1 page: 1 limit: 10 data: - id: 64a844f34aae5bbbe5123721 firstName: Demo lastName: Documentation companyName: ACME paymentMethod: customerVaultId: '362868129' last4: '1111' billingAddress: address: 23462 Street country: US city: Miami state: Florida zipCode: '12345' zipCode: '12345' exp: '1233' name: Demo Card type: credit network: visa brand: visa number: 411111******1111 paymentMethods: - customerVaultId: '362868129' last4: '1111' billingAddress: address: 23462 Street country: US city: Miami state: Florida zipCode: '12345' zipCode: '12345' exp: '1233' name: Demo Card type: credit network: visa brand: visa number: 411111******1111 default: true - customerVaultId: '848904102' last4: '4242' billingAddress: null zipCode: '12345' exp: '1233' name: Demo Card type: credit network: visa brand: visa number: 424242******4242 phoneNumber: '5555555555' email: integration@strictlyzero.com zipCode: '12345' billingAddress: company: '' country: US address: demo address2: '' city: demo state: Alaska shippingAddress: company: '' country: US address: '' address2: '' city: '' state: '' deletedAt: null security: - bearer: [] summary: List of vaults tags: - Customers post: description: >- Create a new customer vault. Payment methods are provided as a `cards` array. The **first card** in the array is automatically set as the default payment method. **Required:** `firstName`, `lastName`. **Optional:** `companyName`, `phoneNumber`, `email` (recommended — required for subscription flows), `zipCode`, `billingAddress`, `shippingAddress`, `gender`, `dateOfBirth`. **Card fields:** `name`, `number` (masked, e.g. `411111******1111`), `exp` (MMYY format), `paymentToken` (from tokenization form), `zipCode`. **Test mode token:** `00000000-000000-000000-000000000000`. operationId: createCustomer parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CustomerPublicDto' examples: example1: summary: Create Customer value: firstName: John lastName: Doe companyName: ACME phoneNumber: '5555555555' email: test@example.com zipCode: '12345' billingAddress: country: US address: demo city: demo state: Alaska cards: - name: Demo Card number: 411111******1111 exp: '1233' paymentToken: 00000000-000000-000000-000000000000 zipCode: '12345' responses: '201': description: Customer vault created. content: application/json: examples: example1: summary: Create Customer value: data: id: 64a887cbda3217c59ba20664 firstName: Demo lastName: Documentation companyName: ACME paymentMethod: customerVaultId: '1900457053' last4: '1111' billingAddress: null zipCode: '12345' exp: '1122' name: Demo Card type: credit network: visa brand: visa number: 411111******1111 paymentMethods: - customerVaultId: '1900457053' last4: '1111' billingAddress: null zipCode: '12345' exp: '1122' name: Demo Card type: credit network: visa brand: visa number: 411111******1111 default: true phoneNumber: '5555555555' email: integration@strictlyzero.com zipCode: '12345' billingAddress: company: '' country: US address: demo address2: '' city: demo state: Alaska shippingAddress: company: '' country: US address: '' address2: '' city: '' state: '' deletedAt: null '400': description: Bad Request '401': description: Unauthorized security: - bearer: [] summary: Create customer vault tags: - Customers /v1/public/customer/{id}: patch: description: Partial update of a customer vault. operationId: updateCustomer parameters: - name: id required: true in: path description: Customer vault ID schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CustomerUpdatePublicDto' examples: example1: summary: Update Customer value: firstName: test lastName: support companyName: new cards: - name: new number: 424242******4242 network: visa exp: '1233' paymentToken: 00000000-000000-000000-000000000000 last4: '4242' type: credit zipCode: '12345' phoneNumber: '5555555555' email: integration@strictlyzero.com zipCode: '12345' billingAddress: country: ZM address: '' city: '' state: Drumba responses: '200': description: Customer updated. content: application/json: examples: example1: summary: Update Customer value: data: id: 64a887cbda3217c59ba20664 firstName: test lastName: support companyName: new paymentMethod: customerVaultId: '1900457053' last4: '1111' billingAddress: null zipCode: '12345' exp: '1122' name: Demo Card type: credit network: visa brand: visa number: 411111******1111 paymentMethods: - customerVaultId: '1900457053' last4: '1111' billingAddress: null zipCode: '12345' exp: '1122' name: Demo Card type: credit network: visa brand: visa number: 411111******1111 default: true - customerVaultId: '370832924' last4: '4242' billingAddress: null zipCode: '12345' exp: '1233' name: new type: credit network: visa brand: visa number: 424242******4242 phoneNumber: '5555555555' email: integration@strictlyzero.com zipCode: '12345' billingAddress: company: '' country: ZM address: demo address2: '' city: demo state: Drumba shippingAddress: company: '' country: US address: '' address2: '' city: '' state: '' deletedAt: null '400': description: Bad Request '404': description: Customer not found security: - bearer: [] summary: Update customer tags: - Customers delete: description: Permanently delete a customer vault. operationId: deleteCustomer parameters: - name: id required: true in: path description: Customer vault ID schema: type: string responses: '200': description: Customer deleted. content: application/json: examples: example1: summary: Delete Customer value: data: id: 649312bacf2bc267b6568ee6 firstName: Demo lastName: Documentation companyName: ACME Updated paymentMethod: null paymentMethods: [] phoneNumber: '5555555555' email: integration@strictlyzero.com zipCode: '12345' billingAddress: company: '' country: US address: demo address2: '' city: demo state: Alaska shippingAddress: company: '' country: '' address: '' address2: '' city: '' state: '' deletedAt: '2023-07-07T21:48:57.747Z' example2: summary: Bulk Delete Customer value: data: success: true '404': description: Not Found security: - bearer: [] summary: Delete customer by id tags: - Customers get: description: Retrieve a single customer vault with all stored payment methods. operationId: getCustomer parameters: - name: id required: true in: path description: Customer vault ID schema: type: string responses: '200': description: Customer vault returned. content: application/json: examples: example1: summary: Get Customer value: data: id: 649311b1cf2bc267b6568bd9 firstName: Demo lastName: Documentation companyName: ACME paymentMethod: customerVaultId: '1653471921' last4: '1111' billingAddress: null zipCode: '12345' exp: '1233' name: Demo Card type: credit network: visa brand: visa number: 411111******1111 paymentMethods: - customerVaultId: '1653471921' last4: '1111' billingAddress: null zipCode: '12345' exp: '1233' name: Demo Card type: credit network: visa brand: visa number: 411111******1111 default: true phoneNumber: '5555555555' email: integration@strictlyzero.com zipCode: '' billingAddress: company: ACME country: US address: '' address2: '' city: demo state: Alaska shippingAddress: company: ACME country: US address: '' address2: '' city: '' state: '' deletedAt: null '404': description: Not Found security: - bearer: [] summary: View customer by id tags: - Customers /v1/public/customer/bulk-delete: delete: description: >- Delete multiple customer vaults by their IDs. Provide `itemList` (array of customer vault IDs) in the request body. operationId: bulkDeleteCustomers parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CustomerBulkActionDto' examples: example1: summary: Bulk Delete Customer value: itemList: - CUSTOMER_ID responses: '200': description: Customers deleted. content: application/json: examples: example1: summary: Bulk Delete Customer value: data: success: true '400': description: Bad Request security: - bearer: [] summary: Bulk delete customer vaults tags: - Customers /v1/public/customer/card/{id}/{customerVaultId}: delete: description: >- Remove a stored card from a customer vault. **Note:** If the card has an active subscription associated with it, deletion will be rejected with an error. Cancel or reassign the subscription first. operationId: deleteCustomerCard parameters: - name: customerVaultId required: true in: path description: Customer vault ID schema: type: string - name: id required: true in: path description: Stored card vault ID schema: type: string responses: '200': description: Card removed. content: application/json: examples: example1: summary: Remove Payment Card value: data: id: 64a8893f18aa5fff171895ef firstName: Demo lastName: Documentation companyName: ACME paymentMethod: {} paymentMethods: [] phoneNumber: '5555555555' email: integration@strictlyzero.com zipCode: '12345' billingAddress: company: '' country: US address: demo address2: '' city: demo state: Alaska shippingAddress: company: '' country: US address: '' address2: '' city: '' state: '' deletedAt: null '404': description: Not Found security: - bearer: [] summary: Delete customer card tags: - Customers patch: description: Update an existing stored card in a customer vault. operationId: updateCustomerCard parameters: - name: id required: true in: path description: Customer vault ID schema: type: string - name: customerVaultId required: true in: path description: Stored card vault ID schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CustomerCardCreateDto' examples: example1: summary: Update Payment Card value: name: Demo Card number: 411111******1111 exp: '1233' paymentToken: 00000000-000000-000000-000000000000 zipCode: '12345' responses: '200': description: Card updated. content: application/json: examples: example1: summary: Update Payment Card value: data: customerVaultId: '594679112' bin: 411111 name: Demo Card number: 411111******1111 network: visa exp: '1233' paymentToken: 00000000-000000-000000-000000000000 last4: '1111' type: credit zipCode: '12345' clientId: 60d3a4008ff956001d85da21 security: - bearer: [] summary: Update vault card by id tags: - Customers /v1/public/customer/bulk-update-request: post: description: >- Send a payment-update request link to multiple existing customers at once. Equivalent to calling /update-request/:id for each customer. **Body fields:** `itemList` (array of customer IDs), `expirationTime` (number), `unitOfTime` (`minutes`, `hours`, `days`, `weeks`). operationId: bulkUpdateRequest parameters: - name: authorization required: true in: header schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CustomerBulkUpdateRequestDto' examples: example1: summary: Bulk Update Request value: itemList: - VAULT_ID expirationTime: 1 unitOfTime: day responses: '200': description: Requests sent. content: application/json: examples: example1: summary: Bulk Update Request value: success: true security: - bearer: [] summary: Bulk update request tags: - Customers /v1/public/customer/send-invitation: post: description: >- Send a secure link so that a new customer can enter their own payment details. Use this for new customers only — for existing customers use /update-request/:id. **Body fields:** `expirationTime` (required, number), `unitOfTime` (required: `minutes`, `hours`, `days`, `weeks`), `email` (optional), `phoneNumber` (optional, any valid US number including area code, e.g. `786 322 0000`). operationId: sendCustomerInvitation parameters: - name: authorization required: true in: header schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CustomerUpdateRequestDto' examples: example1: summary: Send Invitation value: expirationTime: 1 unitOfTime: day phoneNumber: 555-555-5555 email: test@example.com responses: '200': description: Invitation sent. content: application/json: examples: example1: summary: Send Invitation value: success: true security: - bearer: [] summary: Send invitation to new customer tags: - Customers /v1/public/customer/update-request/{id}: post: description: >- Send a secure link to an existing customer so they can update their payment details. Use when a customer's payment info is incomplete, missing, or needs to be changed. **Body fields:** `expirationTime` (required, number), `unitOfTime` (required: `minutes`, `hours`, `days`, `weeks`), `email` (optional), `phoneNumber` (optional, any valid US number including area code). operationId: sendUpdateRequest parameters: - name: id required: true in: path description: Customer vault ID schema: type: string - name: authorization required: true in: header schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CustomerUpdateRequestDto' examples: example1: summary: Update Request value: expirationTime: 1 unitOfTime: day phoneNumber: 555-555-5555 email: test@example.com responses: '200': description: Request sent. security: - bearer: [] summary: Send update request to existing customer tags: - Customers /v1/public/customer/customer-csv: get: description: Export all customer vaults as a downloadable CSV file. operationId: exportCustomerCsv parameters: - name: clientId required: true in: query description: Client identifier schema: type: string responses: '200': description: CSV file download. security: - bearer: [] summary: Get customers vault CSV tags: - Customers /v1/public/customer/csv-template: get: description: Download a blank CSV template for customer import. operationId: customerCsvTemplate parameters: - name: clientId required: true in: query description: Client identifier schema: type: string responses: '200': description: CSV template file. security: - bearer: [] summary: Get a customer vault template CSV tags: - Customers /v1/public/customer/import-customers: post: description: Upload a CSV file of customers to bulk-import into the vault. operationId: importCustomers parameters: [] requestBody: required: true content: multipart/form-data: schema: type: object required: - file properties: file: type: string format: binary description: CSV file to upload responses: '201': description: Import started. '400': description: Bad Request — invalid file format. security: - bearer: [] summary: Import customers from a CSV file tags: - Customers /v1/public/customer/card/{id}: post: description: >- Add a new stored card (payment method) to an existing customer vault. **Required fields:** `number` (masked, e.g. `411111******1111`), `paymentToken` (from tokenization form, single-use). **Optional:** `name`, `exp` (MMYY format), `zipCode`, `billingAddress`. **Test mode token:** `00000000-000000-000000-000000000000`. **`zipCode` regex:** `/^[0-9]{5}(?:-[0-9]{4})?$/g`. operationId: addCustomerCard parameters: - name: id required: true in: path description: Customer vault ID schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CustomerCardCreateDto' examples: example1: summary: Add Payment Card value: billingAddress: address: 23462 Street address2: '' country: US city: Miami state: Florida zipCode: '12345' name: Demo Card number: 411111******1111 exp: '1233' paymentToken: 00000000-000000-000000-000000000000 zipCode: '12345' responses: '201': description: Card added. content: application/json: examples: example1: summary: Add Payment Card value: data: bin: 411111 name: Demo Card number: 411111******1111 network: visa exp: '1233' paymentToken: 00000000-000000-000000-000000000000 last4: '1111' type: credit zipCode: '12345' clientId: 60d3a4008ff956001d85da21 customerVaultId: '1853226105' '404': description: Customer not found security: - bearer: [] summary: Add card to customer vault tags: - Customers /v1/public/customer/card/{id}/{customerVaultId}/default: patch: description: Mark a stored card as the default payment method for this customer vault. operationId: setDefaultCard parameters: - name: id required: true in: path description: Customer vault ID schema: type: string - name: customerVaultId required: true in: path description: Stored card vault ID schema: type: string responses: '200': description: Default card updated. security: - bearer: [] summary: Update default vault card by id tags: - Customers /v1/public/customer/ach/{id}: post: description: Add an ACH bank account to a customer vault. operationId: addCustomerAch parameters: - name: id required: true in: path description: Customer vault ID schema: type: string responses: '201': description: ACH account added. security: - bearer: [] summary: Add vault ACH by id tags: - Customers /v1/public/customer/ach/{id}/{customerVaultId}/default: patch: description: Mark an ACH account as the default payment method for this customer vault. operationId: setDefaultAch parameters: - name: id required: true in: path description: Customer vault ID schema: type: string - name: customerVaultId required: true in: path description: ACH vault ID schema: type: string responses: '200': description: Default payment method updated. security: - bearer: [] summary: Update default vault PaymentMethod by id tags: - Customers /v1/public/customer/ach/{id}/{customerVaultId}: patch: description: Update an existing ACH bank account in a customer vault. operationId: updateCustomerAch parameters: - name: id required: true in: path description: Customer vault ID schema: type: string - name: customerVaultId required: true in: path description: ACH vault ID schema: type: string responses: '200': description: ACH account updated. security: - bearer: [] summary: Update vault ACH by id tags: - Customers /v1/public/invoice: post: description: >- Create a new invoice with line items, billing address, and optional shipping. Accepts both standard and flexible item formats. **`terms` values:** `upon_receipt`, `7`, `14`, `30` (days). **`items`:** Array of `{ id, qty, taxes[] }` — required. **`billingAddress`** and **`showBilling`/`showShipping`** control whether addresses are shown/required on the payment page. **`customValues`:** Extra properties passed to the payment form. Keys must be pre-configured in the merchant setup. **`applyDiscount`:** If applicable, applies a configured credit card discount. **`customerId`** links the invoice to a customer vault. **`overrideDefaultPaymentMethod`:** Override the default payment method from the customer vault. operationId: createInvoice parameters: - name: authorization required: true in: header schema: type: string requestBody: required: true content: application/json: schema: oneOf: - $ref: '#/components/schemas/InvoiceCreateDto' - $ref: '#/components/schemas/InvoiceFlexibleCreateDto' examples: example1: summary: Create Invoice value: terms: upon_receipt items: - id: 694b00fc84a2a07d10c09c33 qty: 1 taxes: - 653bd6ffbefb29d425276854 - id: 6948fbd26a868e5ce37f5201 qty: 10 taxes: [] billingAddress: firstName: EXAMPLE lastName: EXAMPLE address: demo city: demo country: US state: Alaska zipCode: EXAMPLE email: EXAMPLE phoneNumber: EXAMPLE shippingAddress: {} showBilling: false showShipping: false customValues: - key: customer_id label: Customer ID value: '213213123' applyDiscount: true customerId: 691c30e7e2ad9abbfe5d609e overrideDefaultPaymentMethod: '1502781412' responses: '201': description: Invoice created. content: application/json: examples: example1: summary: Create Invoice value: data: invoicing: add_invoice invoiceNumber: STR-CYT-251223-10995 amount: 14.9 cost: 14.9 activity: - code: Invoice Created description: A new Invoice was created by Support Zero. date: '2025-12-23T20:27:09.407Z' customValues: - key: customer_id label: Customer ID value: '213213123' valueLabel: '' tax: 0 shipping: 0 discount: 0 paidAmount: 0 paidSurcharge: 0 terms: upon_receipt status: draft customerId: 691c30e7e2ad9abbfe5d609e currency: USD clientId: 653a665504639e469f99096b clientName: Coders Strictly Tests createdAt: '2025-12-23T20:27:09.407Z' updatedAt: '2025-12-23T20:27:09.407Z' id: 676a1b4d9d17e6d8e6409abc '400': description: Bad Request '401': description: Unauthorized security: - bearer: [] summary: Create invoice tags: - Invoices get: description: Returns a paginated list of invoices, optionally filtered by date range, client, or order ID. operationId: listInvoices parameters: - name: page required: false in: query description: Page number for paginating schema: type: number - name: limit required: false in: query description: Limit items per page schema: type: number - name: orderId required: false in: query description: Order identifier schema: type: string - name: clientId required: false in: query description: Client identifier schema: type: string - name: startDay required: false in: query description: Filter Invoice by Start Date schema: type: string - name: endDay required: false in: query description: Filter Invoice by Snd Date schema: type: string - name: startDueDay required: false in: query description: Filter Invoice by Start DueDate schema: type: string - name: endDueDay required: false in: query description: Filter Invoice by End DueDate schema: type: string - name: authorization required: true in: header schema: type: string responses: '200': description: Paginated invoices list. content: application/json: examples: example1: summary: List Invoice value: meta: count: 5557 totalPages: 223 page: '1' limit: '25' data: - clientId: 653a665504639e469f99096b clientName: Coders Strictly Tests companyName: Cypress e2e testing invoicing: add_invoice invoiceNumber: STR-CYT-251226-11054 amount: 1 cost: 1 activity: - code: Invoice Created description: A new Invoice was created by Automated Testing User. date: '2025-12-26T17:13:02.292Z' customValues: - key: customer_id label: Customer ID value: Ramdom123 valueLabel: null terms: upon_receipt dueDate: '2025-12-27T04:59:59.999Z' customerId: 694e4340493051827954d6bc currency: USD status: paid-in-full paidAmount: 1 paidSurcharge: 0 id: 694ec21e41871d63c73f0a26 security: - bearer: [] summary: List of invoices tags: - Invoices /v1/public/invoice/{id}: patch: description: >- Update an existing invoice. **`status` values:** `draft`, `overdue`, `sent`, `paid-in-full`, `partially-paid`, `cancelled` (default: `draft`). **To cancel an invoice:** Send `{ "status": "cancelled" }`. **`terms` values (for update):** `upon_receipt`, `30`, `60`, `90`. **`applyDiscount`:** Apply/remove the configured credit card discount. **`customValues`:** Update custom field values (keys must be pre-configured in merchant setup). operationId: updateInvoice parameters: - name: authorization required: true in: header schema: type: string - name: id required: true in: path description: Invoice ID schema: type: string requestBody: required: true content: application/json: schema: type: object examples: example1: summary: Update Invoice value: products: [] billingAddress: {} shippingAddress: {} showBilling: false showShipping: false dueDate: '2024-10-27T03:59:59.999Z' customValues: - key: customer_code value: COD-1234 example2: summary: Cancel Invoice value: status: cancelled responses: '200': description: Invoice updated. content: application/json: examples: example1: summary: Update Invoice value: data: clientId: 653a665504639e469f99096b clientName: Coders Strictly Tests companyName: Cypress e2e Testing invoicing: add_invoice invoiceNumber: STR-CYT-251226-11050 amount: 1 cost: 1 terms: upon_receipt dueDate: '2025-12-29T03:59:59.999Z' currency: USD status: draft paidAmount: 0 paidSurcharge: 0 id: 694ec1ae41871d63c73f093a example2: summary: Cancel Invoice value: data: invoicing: add_invoice terms: upon_receipt customerId: '' currency: USD cardInfo: null orderDescription: '' tax: 0 discount: 0 paidAmount: 0 paidSurcharge: 0 status: sent showBilling: false showShipping: false amount: 0.34 clientId: 60d3a4008ff956001d85da21 clientName: Coders NMI invoiceNumber: CODNMI-211022-00196 id: 61732c96b8713f001c9de6ce '400': description: Bad Request content: application/json: examples: example1: summary: Cancel Invoice with error value: statusCode: 400 timestamp: '2022-03-30T23:12:26.414Z' path: /v1/public/invoice/62434ad42da210001f8f0fa5 response: This Invoice is already canceled. status: 400 message: This Invoice is already canceled. '404': description: Not Found security: - bearer: [] summary: Update invoice tags: - Invoices delete: description: Permanently delete an invoice. operationId: deleteInvoice parameters: - name: id required: true in: path description: Invoice ID schema: type: string - name: authorization required: true in: header schema: type: string responses: '200': description: Invoice deleted. content: application/json: examples: example1: summary: Delete Invoice value: data: invoicing: add_invoice terms: upon_receipt customerId: '' currency: USD cardInfo: null orderDescription: '' shipping: 0 tax: 0 paidAmount: 0 paidSurcharge: 0 status: sent showBilling: false showShipping: false amount: 0.3 clientId: 60d3a4008ff956001d85da21 clientName: Coders NMI invoiceNumber: CODNMI-211022-00193 id: 6172de232dc8f13e0b1ab1ac '400': description: Bad Request content: application/json: examples: example1: summary: Delete Invoice with error value: statusCode: 400 timestamp: '2022-03-30T23:12:57.792Z' path: /v1/public/invoice/62434ad42da210001f8f0fa5 response: This Invoice is already canceled. status: 400 message: This Invoice is already canceled. '404': description: Not Found security: - bearer: [] summary: Delete invoice by id tags: - Invoices /v1/public/invoice/{id}/send-by-email: post: description: Send an invoice to a customer via email. Provide `email` in the request body. operationId: sendInvoiceByEmail parameters: - name: authorization required: true in: header schema: type: string - name: id required: true in: path description: Invoice ID schema: type: string requestBody: required: true content: application/json: schema: type: object properties: email: type: string examples: example1: summary: Share / Send Invoice by email value: email: test@example.com responses: '200': description: Invoice sent. security: - bearer: [] summary: Send invoice by email tags: - Invoices /v1/public/invoice/{id}/invoice-pdf: get: description: >- Generate a PDF file for the given invoice. Returns a JSON object with `fileName` and `fileUrl` (the URL to download the PDF). operationId: invoicePdf parameters: - name: invoiceId required: false in: query description: Invoice identifier schema: type: string - name: clientId required: true in: query description: Merchant client ID schema: type: string - name: id required: true in: path description: Invoice ID schema: type: string - name: authorization required: true in: header schema: type: string responses: '200': description: PDF generated. content: application/json: examples: example1: summary: Invoice PDF value: fileName: invoice_64de36fad977023e05fc06df.pdf fileUrl: >- https://storage.googleapis.com/zero-prod-out-of-scope-files/attachments/60d3a4008ff956001d85da21/download-invoice/invoice_64de36fad977023e05fc06df.pdf security: - bearer: [] summary: Generate invoice PDF tags: - Invoices /v1/public/invoice/{id}/single: get: description: Retrieve a single invoice by ID. operationId: getInvoice parameters: - name: id required: true in: path description: Invoice ID schema: type: string responses: '200': description: Invoice returned. content: application/json: examples: example1: summary: Get Single Invoice value: data: currency: USD amount: 1 paidAmount: 1 paidSurcharge: 0 companyName: Cypress e2e testing billingAddress: firstName: Mario lastName: Herrera company: '' country: US address: '' address2: '' city: Miami state: Alaska zipCode: '' phoneNumber: '1337133713' email: rvmesa85@gmail.com shippingAddress: firstName: Mario lastName: Herrera company: '' country: US address: '' address2: '' city: Miami state: Alaska zipCode: '' phoneNumber: '1337133713' email: rvmesa85@gmail.com products: [] items: - id: 694ec1a341871d63c73f091f name: TempItemBA clientId: 653a665504639e469f99096b description: description type: product qty: 1 salesPrice: 1 discount: 0 total: 1 taxes: [] categories: [] sku: '' cost: 1 tax: 0 clientId: 653a665504639e469f99096b clientName: Coders Strictly Tests dueDate: '2025-12-27T04:59:59.999Z' invoiceNumber: STR-CYT-251226-11054 status: paid-in-full '404': description: Not Found security: - bearer: [] summary: View public invoice by id tags: - Invoices /v1/public/invoice/{id}/send-by-sms: post: description: >- Send a payment link for this invoice via SMS. Provide `phoneNumber` (any valid US number including area code) in the request body. operationId: sendInvoiceBySms parameters: - name: id required: true in: path description: Invoice ID schema: type: string - name: authorization required: true in: header schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SendBySmsDto' examples: example1: summary: Share / Send Invoice by sms value: phoneNumber: '5555555555' responses: '200': description: SMS sent. content: application/json: examples: example1: summary: Share / Send Invoice by sms value: data: success: true security: - bearer: [] summary: Send invoice by SMS tags: - Invoices /v1/public/item: post: description: Create a new product/service item in the catalog. operationId: createItem parameters: - name: authorization required: true in: header schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateItemDto' examples: example1: summary: Create Item value: name: Test api item type: product description: test salesPrice: -5.5 categories: - name: cat id: 6243240a2da210001f8f0cb3 - name: cat2 id: null taxes: [] sku: '1234' responses: '201': description: Item created. content: application/json: examples: example1: summary: Create Item value: data: categories: - name: cat createdAt: '2022-03-29T17:24:53.876Z' updatedAt: '2022-03-29T17:24:53.876Z' id: 624340e564d1f81e59d730fd - name: cat1 createdAt: '2022-03-29T17:24:53.876Z' updatedAt: '2022-03-29T17:24:53.876Z' id: 624340e564d1f81e59d730fd taxes: [] deletedAt: null name: Test api item type: product description: test salesPrice: 0.3 sku: '1234' createdBy: EXAMPLE updatedBy: EXAMPLE owner: EXAMPLE ownerGroup: null createdAt: '2022-03-29T12:17:18.227Z' updatedAt: '2022-03-29T12:17:18.227Z' id: EXAMPLE '400': description: Bad Request '401': description: Unauthorized security: - bearer: [] summary: Create an item tags: - Items get: description: Returns a paginated list of catalog items. operationId: listItems parameters: - name: authorization required: true in: header schema: type: string responses: '200': description: Paginated items list. content: application/json: schema: type: object properties: data: type: array items: type: object total: type: integer page: type: integer limit: type: integer security: - bearer: [] summary: List of Items tags: - Items /v1/public/item/select-all: get: description: Returns all items without pagination — use for dropdowns/autocomplete. operationId: selectAllItems parameters: - name: authorization required: true in: header schema: type: string responses: '200': description: All items returned. security: - bearer: [] summary: List of items tags: - Items /v1/public/item/categories: get: description: Returns all item categories. operationId: listItemCategories parameters: - name: authorization required: true in: header schema: type: string responses: '200': description: Categories returned. content: application/json: examples: example1: summary: Get Categories value: - name: Computers createdAt: '2021-06-24T13:03:31.600Z' updatedAt: '2021-06-24T13:03:31.600Z' id: 60d482a30e64b7001ca3efe4 - name: Apple createdAt: '2021-06-24T13:03:31.600Z' updatedAt: '2021-06-24T13:03:31.600Z' id: 60d482a30e64b7001ca3efe5 security: - bearer: [] summary: List of categories tags: - Items /v1/public/item/{id}: get: description: Retrieve a single item by ID. operationId: getItem parameters: - name: id required: true in: path description: Item ID schema: type: string - name: authorization required: true in: header schema: type: string responses: '200': description: Item returned. content: application/json: examples: example1: summary: Get Item value: data: categories: - name: cat createdAt: '2022-03-29T15:21:46.095Z' updatedAt: '2022-03-29T15:21:46.095Z' id: 6243240a2da210001f8f0cb3 taxes: [] deletedAt: '2022-03-29T12:26:47.933Z' name: Test api item type: product description: test api salesPrice: 0.3 sku: '1234' clientId: 5ff76fb63bcf0a001c6228e0 createdBy: EXAMPLE updatedBy: EXAMPLE owner: EXAMPLE ownerGroup: null createdAt: '2022-03-29T12:17:18.227Z' updatedAt: '2022-03-29T17:20:09.134Z' id: EXAMPLE '404': description: Not Found security: - bearer: [] summary: Get one Item by id tags: - Items patch: description: Partial update of a catalog item. operationId: updateItem parameters: - name: id required: true in: path description: Item ID schema: type: string - name: authorization required: true in: header schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateItemDto' examples: example1: summary: Update Item value: description: test api categories: - name: cat id: null - name: cat1 id: 6243240a2da210001f8f0cb3 taxes: [] responses: '200': description: Item updated. content: application/json: examples: example1: summary: Update Item value: data: categories: [] taxes: [] deletedAt: null name: Test api item type: product description: test salesPrice: 0.3 sku: '1234' createdBy: EXAMPLE updatedBy: EXAMPLE owner: EXAMPLE ownerGroup: null createdAt: '2022-03-29T12:17:18.227Z' updatedAt: '2022-03-29T12:17:18.227Z' id: EXAMPLE '404': description: Not Found security: - bearer: [] summary: Update an Item tags: - Items delete: description: Permanently delete a catalog item. operationId: deleteItem parameters: - name: id required: true in: path description: Item ID schema: type: string - name: authorization required: true in: header schema: type: string responses: '200': description: Item deleted. content: application/json: examples: example1: summary: Delete Item value: data: categories: [] taxes: [] deletedAt: null name: Test api item type: product description: test api salesPrice: 0.3 sku: '1234' createdBy: EXAMPLE updatedBy: EXAMPLE owner: EXAMPLE ownerGroup: null createdAt: '2022-03-29T12:17:18.227Z' updatedAt: '2022-03-29T12:26:11.609Z' id: EXAMPLE '404': description: Not Found security: - bearer: [] summary: Delete a item by id tags: - Items /v1/public/item/bulk-delete: post: description: Delete multiple catalog items by ID list. operationId: bulkDeleteItems parameters: - name: authorization required: true in: header schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ItemBulkActionDto' responses: '200': description: Items deleted. security: - bearer: [] summary: Delete a list of items tags: - Items /v1/public/item/duplicate/{id}: post: description: Create a copy of an existing item. operationId: duplicateItem parameters: - name: id required: true in: path description: Item ID to duplicate schema: type: string - name: authorization required: true in: header schema: type: string responses: '201': description: Duplicate created. '404': description: Not Found security: - bearer: [] summary: Duplicate an item tags: - Items /v1/public/item/bulk-duplicate: post: description: Duplicate multiple items at once. operationId: bulkDuplicateItems parameters: - name: authorization required: true in: header schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ItemBulkActionDto' responses: '200': description: Duplicates created. security: - bearer: [] summary: Duplicate a list item tags: - Items /v1/public/payment/receipt-pdf: post: description: >- Retrieve the PDF representation of the receipt for a given payment in base64 format. Provide `paymentId` and optionally `isForMerchant` (default: true) to indicate whether the receipt is for the merchant or customer copy. operationId: receiptPdf parameters: - name: authorization required: true in: header schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PaymentReceiptPdfDto' examples: example1: summary: Receipt PDF value: paymentId: PAYMENT_ID responses: '200': description: PDF generated. Response contains base64-encoded PDF and/or a URL. content: application/json: examples: example1: summary: Receipt PDF value: data: encodeType: base64 pdfData: JVBERi0xLjQK... '400': description: Bad Request '401': description: Unauthorized security: - bearer: [] summary: Get Receipt PDF tags: - Payments /v1/public/payment/rate: get: description: >- Calculate the surcharge/fee rate for a given card BIN and amount. Returns the surcharge amount, rate, type, and card brand. Use this before charging to display the final amount to customers. `tokenId` is required only when using the Strictly gateway (alternative to `binCard`). operationId: getPaymentRate parameters: - name: amount required: true in: query schema: type: string description: Amount in dollars (e.g. "101"). Supports up to eight digits. - name: clientId required: true in: query schema: type: string - name: binCard required: true in: query schema: type: string description: First 6 digits of the card number (BIN/IIN) - name: tokenId required: false in: query schema: type: string description: Tokenized card ID. Required only when using the Strictly gateway as an alternative to binCard. responses: '200': description: Rate info returned. content: application/json: examples: example1: summary: Get Rate value: data: clientId: EXAMPLE amount: 100 creditRate: 3.5 debitRate: 0 brand: visa cardType: credit totalAmount: 104 surcharge: 4 security: - bearer: [] summary: Get surcharge rate tags: - Payments /v1/public/payment/charge: post: description: >- Create a payment and immediately flag it for settlement when `capture=true` (default). A payment can be made for a card or for an existing customer vault. Set `capture=false` to issue a pre-authorization only — call /capture separately to settle. **Customer vault:** If charging a customer vault, the system uses the default payment method. Override with `overrideDefaultPaymentMethod` set to the desired customerVaultId. **Dual-pricing accounts:** `amount` represents the card price; no surcharge or discount applies for Regular/Dualpricing accounts. **Sandbox/test mode:** Use token `00000000-000000-000000-000000000000` to speed up integration without hitting the network. **To trigger a declined response:** Pass an amount less than 1.00. **`bypassSurcharge`:** Set to true to remove surcharge for exceptions. **`card.number`** must be the masked card number from the tokenization form (e.g. `411111******1111`), regex: `\d{6}[*\.]+\d{4}`. operationId: chargeCard parameters: - name: user-agent required: true in: header schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ChargePublicDto' examples: example1: summary: Charge with card value: amount: EXAMPLE contact: email: EXAMPLE phone: EXAMPLE billingAddress: address: demo city: demo country: US state: Alaska zipCode: '10400' shippingAddress: {} order: amount: EXAMPLE shipping: 0 tax: 0 poNumber: '12345' discount: 0 customValues: - key: customer_code label: Customer Code value: COD-123 capture: true card: name: EXAMPLE number: EXAMPLE paymentToken: EXAMPLE sendReceipt: false example2: summary: Charge with Customer Override value: amount: 100 contact: email: test@example.com phone: 555-555-5555 billingAddress: address: demo city: demo country: US state: Alaska zipCode: '10400' shippingAddress: {} order: amount: 100 shipping: 0 tax: 0 poNumber: '65614' discount: 0 capture: true overrideDefaultPaymentMethod: '1953491483' card: vaultId: CUSTOMER_VAULT_ID sendReceipt: true example3: summary: Charge with Customer (Failed) value: amount: 100 contact: email: test@example.com phone: 555-555-5555 billingAddress: address: demo city: demo country: US state: Alaska zipCode: '10400' shippingAddress: {} order: amount: 100 shipping: 0 tax: 0 poNumber: '65614' discount: 0 capture: true card: vaultId: VAULT_ID sendReceipt: true responses: '201': description: Charge created. content: application/json: examples: example1: summary: Charge With card value: data: id: EXAMPLE object: charge type: sale amount: 104 baseAmount: 100 surcharge: 4 captured: true transactionId: '7041542577' error: false createdAt: '2022-03-07T23:24:56.351Z' transactionAt: '2022-03-07T23:24:56.351Z' settled: false userAgent: PostmanRuntime/7.29.0 device: api paymentId: EXAMPLE createdBy: EXAMPLE updatedBy: EXAMPLE example2: summary: Charge with taxes value: data: id: 689239339d9fe222940bb8fa object: charge type: sale amount: 109 baseAmount: 106 surcharge: 3 currency: USD captured: true transactionId: '805170239' error: false createdAt: '2025-08-05T17:02:43.419Z' transactionAt: '2025-08-05T17:02:43.419Z' settled: false terminalId: '0017340008025359202384' userAgent: PostmanRuntime/7.45.0 device: api paymentId: 689239339d9fe222940bb8fd createdBy: integration@strictlyzero.com updatedBy: integration@strictlyzero.com avsResponse: Z cvvResponse: ' ' authCode: '896974' tax: 6 example3: summary: Charge with Customer Override value: data: id: PAYMENT_ID object: charge type: sale amount: 104 baseAmount: 100 surcharge: 4 captured: true transactionId: '7041260106' error: false createdAt: '2022-03-07T21:41:11.483Z' transactionAt: '2022-03-07T21:41:11.483Z' settled: false userAgent: PostmanRuntime/7.29.0 device: api paymentId: PAYMENT_ID createdBy: integration@strictlyzero.com updatedBy: integration@strictlyzero.com '400': description: Bad Request — validation error or gateway rejection. content: application/json: examples: example1: summary: Charge with Card (Failed) value: statusCode: 400 timestamp: '2022-04-11T22:54:13.822Z' path: /v1/public/payment/charge response: code: '300' text: Transaction was rejected by gateway. message: Http Exception example2: summary: Charge with Customer (Failed) value: statusCode: 400 timestamp: '2022-04-11T22:54:13.822Z' path: /v1/public/payment/charge response: responseCode: '300' responsetext: Duplicate transaction REFID:3148320880 status: 400 message: Http Exception '401': description: Unauthorized. security: - bearer: [] summary: Charge a card tags: - Payments /v1/public/payment/refund: post: description: >- Post a refund on a previously captured payment. Funds are returned to the original credit/debit card. You can refund the full amount or only a portion. Multiple partial refunds are allowed until the charge is fully refunded. Attempting to refund a fully-refunded payment will result in an error. `amount` is expressed in cents (e.g. 100 = $1.00). operationId: refundPayment parameters: - name: user-agent required: true in: header schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RefundPublicDto' examples: example1: summary: Refund value: paymentId: PAYMENT_ID amount: 5 reason: Test responses: '200': description: Refund processed. content: application/json: examples: example1: summary: Refund value: data: id: 603cf453703b893cecec5693 object: refund type: refund amount: 5 currency: USD chargeId: 603cb41e65c579001b7c425f paymentId: 603cb41e65c579001b7c4261 transactionId: '6049153728' error: false createdAt: '2021-03-01T14:04:03.245Z' settled: false userAgent: PostmanRuntime/7.26.10 device: web_zpay createdBy: EXAMPLE updatedBy: EXAMPLE baseAmount: 5 surcharge: 0 '400': description: Bad Request — amount exceeds refundable balance or payment already fully refunded. '401': description: Unauthorized security: - bearer: [] summary: Refund a payment tags: - Payments /v1/public/payment/void: post: description: >- Void an existing payment that has not yet been settled. Once voided, no additional charges can be made. For settled/captured payments, use the refund endpoint instead. **`reason` values:** `fraud`, `user_cancel`, `icc_rejected`, `icc_card_removed`, `icc_no_confirmation`, `pos_timeout`. Set `receipt=true` to send a receipt notification to the customer via email or SMS. operationId: voidPayment parameters: - name: user-agent required: true in: header schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/VoidPublicDto' examples: example1: summary: Void value: paymentId: EXAMPLE reason: user_cancel receipt: true responses: '200': description: Payment voided. content: application/json: examples: example1: summary: Void value: data: id: 603cf273d0c3792a48928ed2 object: void type: void amount: 1 currency: USD chargeId: 603cb41e65c579001b7c426e paymentId: 603cb41e65c579001b7c4272 reason: user_cancel transactionId: '6048258970' error: false createdAt: '2021-03-01T13:56:03.088Z' settled: false userAgent: PostmanRuntime/7.26.10 device: web_zpay createdBy: EXAMPLE updatedBy: EXAMPLE baseAmount: 1 surcharge: 0 '400': description: Bad Request — payment already settled or invalid reason. '401': description: Unauthorized security: - bearer: [] summary: Void a payment tags: - Payments /v1/public/payment/capture: post: description: >- Flag a pre-authorized payment for settlement. Only payments created with `capture=false` can be captured. You can capture an amount equal to or less than the original pre-authorization. Uncaptured payments are not posted to the account until a settlement runs (by default, daily). operationId: capturePayment parameters: - name: user-agent required: true in: header schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CapturePublicDto' examples: example1: summary: Capture value: paymentId: EXAMPLE amount: 4 responses: '200': description: Payment captured. content: application/json: examples: example1: summary: Capture value: data: id: 603cf5a3703b893cecec569c object: capture type: captured amount: 4 currency: USD chargeId: 5feba027cb9358001b00df82 paymentId: 5feba027cb9358001b00df84 transactionId: '5892309495' error: false createdAt: '2021-03-01T14:09:39.533Z' settled: false userAgent: PostmanRuntime/7.26.10 device: web_zpay createdBy: EXAMPLE updatedBy: EXAMPLE baseAmount: 4 surcharge: 0 '400': description: Bad Request '401': description: Unauthorized security: - bearer: [] summary: Capture a pre-authorized payment tags: - Payments /v1/public/payment/acknowledgment: get: description: >- Retrieve the acknowledgment payload for the last terminal transaction. Used in terminal integration flows. `type` controls the response format: `json` (default) or `text`. operationId: getAcknowledgment parameters: - name: clientId required: true in: query description: Merchant client ID schema: type: string - name: type required: false in: query description: Response format — json (default) or text schema: type: string enum: - json - text default: json responses: '200': description: Acknowledgment data returned. security: - bearer: [] summary: Get terminal acknowledgment tags: - Payments /v1/public/payment/{id}: get: description: Retrieve a single payment record by ID. operationId: getPayment parameters: - name: id required: true in: path description: Payment ID schema: type: string responses: '200': description: Payment returned. content: application/json: examples: example1: summary: Get Payment value: data: currency: USD paid: true amountRefunded: 0 surchargeRefunded: 0 voidable: false capturable: false refundable: true error: false transactionErrorMsg: null statusList: - sale sendReceipt: true settled: true clientId: EXAMPLE clientName: Coders card: vaultId: EXAMPLE name: EXAMPLE number: EXAMPLE network: amex exp: '0122' paymentToken: EXAMPLE type: credit last4: '2030' contact: phone: EXAMPLE email: EXAMPLE amount: EXAMPLE surcharge: 0 percent: 3.5 paidAmount: 1 paidAmountSurcharge: 0 status: sale order: shipping: 0 federalTaxes: 0 amount: 0.01 tax: 0 discount: 0 products: [] customValues: - value: Card 1 key: testing label: 'testing ' billingAddress: firstName: EXAMPLE lastName: EXAMPLE company: '' country: US address: '' address2: '' city: '' state: '' zipCode: '33166' phoneNumber: EXAMPLE email: EXAMPLE shippingAddress: firstName: EXAMPLE lastName: EXAMPLE company: '' country: US address: '' address2: '' city: '' state: '' zipCode: '33166' phoneNumber: EXAMPLE email: EXAMPLE transactions: - settled: true createdAt: '2021-02-26T09:30:07.470Z' updatedAt: '2021-02-27T07:30:53.406Z' _id: 6038bf9f2d0291001bd6366e id: 6038bf9f2d0291001bd63664 object: charge type: sale amount: 1 baseAmount: 1 surcharge: 0 currency: USD captured: 'true' transactionId: '6038974094' error: false userAgent: null device: recurring paymentId: 6038bf9f2d0291001bd63668 createdBy: recurring updatedBy: system owner: EXAMPLE ownerGroup: null settlementInfo: date: '2021-02-27T01:26:40.000Z' batchId: '469460546' processorBatchId: '00362' from: subscription fromId: 602b1667a86e34001bcce14c paymentRequestId: null transactionId: '6038974094' createdBy: recurring updatedBy: system owner: EXAMPLE ownerGroup: null createdAt: '2021-02-26T09:30:07.549Z' updatedAt: '2021-02-27T07:30:53.407Z' id: 6038bf9f2d0291001bd63668 example2: summary: Get Rate value: data: clientId: EXAMPLE amount: 100 creditRate: 3.5 debitRate: 0 brand: visa cardType: credit totalAmount: 104 surcharge: 4 '404': description: Not Found security: - bearer: [] summary: API get single payment tags: - Payments /v1/public/payment/bulk-charge: post: description: >- Create a payment from a customer vault for each entry in the `payments` array. Equivalent to calling /charge for a customer multiple times. Processed asynchronously via a Pub/Sub queue — the response only confirms the job was queued. Poll individual payment IDs to check each charge result. Required per-item fields: `amount`, `customerVaultId`. Optional: `bypassSurcharge` (true/false) to remove surcharge for exceptions. operationId: bulkCharge parameters: - name: user-agent required: true in: header schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BulkChargeDto' examples: example1: summary: Bulk Charge value: payments: - amount: EXAMPLE customerVaultId: EXAMPLE customerId: EXAMPLE responses: '200': description: Bulk charge job queued. content: application/json: examples: example1: summary: Success Response value: data: success: true '400': description: Bad Request '401': description: Unauthorized security: - bearer: [] summary: Bulk charge (async) tags: - Payments /v1/public/202104/payment-link: get: description: Returns a paginated list of payment links for the authenticated merchant. operationId: listPaymentLinks parameters: - name: page required: false in: query description: Page number for paginating schema: type: number - name: limit required: false in: query description: Limit items per page schema: type: number - name: authorization required: true in: header schema: type: string responses: '200': description: Paginated payment links. content: application/json: schema: type: object properties: data: type: array items: type: object total: type: integer page: type: integer limit: type: integer security: - bearer: [] summary: API get list of PaymentLink tags: - Payment Links post: description: >- Create a shareable payment link that allows customers to pay a specific amount. **`amount`** — required. **`customValues`** — optional array of `{ key, label, value }` objects shown on the payment form. **Important:** All custom value keys must be pre-configured in the merchant setup. Any key not defined in the merchant configuration will result in an error. **`taxes`** — optional array of tax IDs to apply. **`showBilling`/`showShipping`** — whether to request billing/shipping addresses on the payment form. **`attachments`** — optional file path objects from the /upload-attachments endpoint. operationId: createPaymentLink parameters: - name: authorization required: true in: header schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreatePaymentLinkDto' examples: example1: summary: Create Payment Link value: amount: 100 taxes: 0 showBilling: true showShipping: true responses: '201': description: Payment link created. content: application/json: examples: example1: summary: Create Payment Link value: id: 694ea6e3fff33e2b60346c57 amount: 100 taxes: 0 totalAmount: 100 paidAmount: 0 surcharge: 0 showBilling: true showShipping: true customValues: [] attachments: [] paid: false paidAt: null createdBy: integration@strictlyzero.com updatedBy: integration@strictlyzero.com createdAt: '2025-12-26T15:16:51.987Z' updatedAt: '2025-12-26T15:16:52.167Z' deletedAt: null paymentLink: https://merchant.zerospay.com/zpay/payment-request/694ea6e4fff33e2b60346c59 reference: STR-CYT-251226-22885 applyDiscount: false example2: summary: Create PaymentLink with an array of taxesIds value: id: 694edb8791809d08a5784e83 amount: 1 taxes: 0 totalAmount: 1 paidAmount: 0 surcharge: 0 showBilling: true showShipping: true customValues: - key: customer_id label: Customer ID value: COD-123 valueLabel: '' attachments: [] paid: false paidAt: null createdBy: integration@strictlyzero.com updatedBy: integration@strictlyzero.com createdAt: '2025-12-26T19:01:27.284Z' updatedAt: '2025-12-26T19:01:27.371Z' deletedAt: null paymentLink: https://merchant.zerospay.com/zpay/payment-request/694edb8791809d08a5784e87 reference: STR-CYT-251226-22916 applyDiscount: false '400': description: Bad Request security: - bearer: [] summary: Create payment link tags: - Payment Links /v1/public/202104/payment-link/{id}: get: description: Retrieve a single payment link by ID. operationId: getPaymentLink parameters: - name: id required: true in: path description: Payment link ID schema: type: string - name: authorization required: true in: header schema: type: string responses: '200': description: Payment link returned. content: application/json: examples: example1: summary: Get PaymentLink value: data: id: 694ebfe2fff33e2b6034718d amount: 3 taxes: 0 totalAmount: 3 paidAmount: 2 surcharge: 0.06 showBilling: true showShipping: true customValues: - key: customer_id label: Customer ID value: Ramdom123 valueLabel: '' - key: Test1 label: Test1 value: Ramdom123 valueLabel: '' attachments: [] paid: false paidAt: '2025-12-26T17:04:02.537Z' createdBy: automated-testing-user@strictlyzero.com updatedBy: online createdAt: '2025-12-26T17:03:30.057Z' updatedAt: '2025-12-26T17:04:02.599Z' deletedAt: null paymentLink: https://merchant.zerospay.com/zpay/payment-request/694ebfe2fff33e2b6034718f reference: STR-CYT-251226-22911 applyDiscount: false '404': description: Not Found security: - bearer: [] summary: API view paymentLink by id tags: - Payment Links delete: description: Permanently delete a payment link. operationId: deletePaymentLink parameters: - name: id required: true in: path description: Payment link ID schema: type: string - name: authorization required: true in: header schema: type: string responses: '200': description: Payment link deleted. content: application/json: examples: example1: summary: Delete PaymentLink value: data: clientId: 60e856cce2819f4a3cfa4294 order: currency: USD amount: 100 shipping: 0 discount: 0 tax: 0 poNumber: '47498' products: [] customValues: - key: external-identifier label: External Identifier value: '356' valueLabel: '' - key: location label: Location value: florida valueLabel: Florida totalAmount: 100 active: false from: paymentLink fromId: 678a673d510ae75f40a1a0fc showBilling: true showShipping: true signedOrder: false deletedAt: '2025-02-21T02:02:16.298Z' createdBy: rosita6505@gmail.com updatedBy: rosita6505@gmail.com owner: rosita6505@gmail.com ownerGroup: null attachments: [] createdAt: '2025-01-17T14:20:45.422Z' updatedAt: '2025-02-21T02:02:16.302Z' id: 678a673d510ae75f40a1a0fe '404': description: Not Found security: - bearer: [] summary: API delete paymentLink by id tags: - Payment Links /v1/public/202104/payment-link/send-by-email: post: description: Send a payment link to a customer via email. Provide `paymentLinkId` and `email` in the request body. operationId: sendPaymentLinkByEmail parameters: - name: authorization required: true in: header schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SendByEmailPublicDto' examples: example1: summary: Share by Email value: email: EXAMPLE paymentLinkId: EXAMPLE responses: '200': description: Email sent. content: application/json: examples: example1: summary: Share by Email value: data: success: true '400': description: Bad Request security: - bearer: [] summary: Share payment link by email tags: - Payment Links /v1/public/202104/payment-link/send-by-sms: post: description: >- Send a payment link to a customer via SMS. Provide `paymentLinkId` and `phoneNumber` (any valid US number including area code, e.g. `786 322 0000`) in the request body. operationId: sendPaymentLinkBySms parameters: - name: authorization required: true in: header schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SendBySmsDto' examples: example1: summary: Share by SMS value: phoneNumber: EXAMPLE paymentLinkId: EXAMPLE responses: '200': description: SMS sent. content: application/json: examples: example1: summary: Share By SMS value: data: success: true '400': description: Bad Request security: - bearer: [] summary: Share payment link by SMS tags: - Payment Links /v1/public/202104/payment-link/upload-attachments: post: description: >- Upload files to attach to a payment link. Returns file path objects to use in the `attachments` field when creating a payment link. **File limits:** Up to 10 files per request, max 25 MB total size. **Supported formats:** JPG, PNG, PDF. operationId: uploadPaymentLinkAttachments parameters: [] requestBody: required: true content: multipart/form-data: schema: type: object required: - file properties: file: type: array items: type: string format: binary responses: '200': description: Files uploaded. content: application/json: schema: type: object properties: message: type: string files: type: array items: type: object '400': description: Bad Request — file validation failed. security: - bearer: [] summary: Upload payment link attachments tags: - Payment Links /v1/public/payment-link: get: deprecated: true description: DEPRECATED — use GET /public/202104/payment-link instead. Returns paginated payment links. operationId: listPaymentLinksDeprecated parameters: - name: page required: false in: query description: Page number for paginating schema: type: number - name: limit required: false in: query description: Limit items per page schema: type: number - name: authorization required: true in: header schema: type: string responses: '200': description: Paginated payment links (deprecated format). content: application/json: schema: type: object properties: data: type: array items: type: object total: type: integer page: type: integer limit: type: integer security: - bearer: [] summary: API get list of PaymentLink tags: - Payment Links (Deprecated) post: deprecated: true description: >- DEPRECATED — use POST /public/202104/payment-link instead. `customValues` keys must be pre-configured in the merchant setup. Optionally include `showBilling`, `showShipping`, `taxes`, and `attachments`. operationId: createPaymentLinkDeprecated parameters: - name: authorization required: true in: header schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreatePaymentLinkDto' examples: example1: summary: Create PaymentLink value: amount: 1 customValues: - key: customer_id label: Customer ID value: COD-123 showBilling: true showShipping: true taxes: - 653bd6ffbefb29d425276854 responses: '201': description: Payment link created (deprecated format). content: application/json: examples: example1: summary: Create PaymentLink value: amount: 1 taxes: 6 selectedTaxes: - id: 653bd6ffbefb29d425276854 clientId: 653a665504639e469f99096b taxName: Washington percentage: 6 _id: 694e771e9d17e6d8e640a52c totalAmount: 1.06 paid: false reference: STR-CYT-251226-22877 paidAmount: 0 surcharge: 0 discount: 0 paymentMethod: null paidAt: null applyDiscount: false clientId: 653a665504639e469f99096b clientName: Coders Strictly Tests status: unpaid showBilling: true showShipping: true customValues: - key: customer_id label: Customer ID value: COD-123 valueLabel: '' createdBy: email updatedBy: email activity: - code: Payment Link Created description: Payment Link was created by username. date: '2025-12-26T11:53:02.705Z' sharedWith: [] deletedAt: null payments: [] attachments: [] createdAt: '2025-12-26T11:53:02.709Z' updatedAt: '2025-12-26T11:53:03.434Z' paymentLink: .zerospay.com/zpay/payment-request/694e771f9d17e6d8e640a52e paymentRequestId: 694e771f9d17e6d8e640a52e id: 694e771e9d17e6d8e640a52b security: - bearer: [] summary: Create payment link tags: - Payment Links (Deprecated) /v1/public/payment-link/{id}: get: deprecated: true description: DEPRECATED — use GET /public/202104/payment-link/:id instead. operationId: getPaymentLinkDeprecated parameters: - name: id required: true in: path description: Payment link ID schema: type: string - name: authorization required: true in: header schema: type: string responses: '200': description: Payment link returned. content: application/json: examples: example1: summary: Get PaymentLink value: data: amount: 3 taxes: 0 totalAmount: 3 paid: false reference: STR-CYT-251226-22911 paidAmount: 2 surcharge: 0.06 discount: 0 paymentMethod: billingAddress: null last4: '9586' paymentToken: c44a0a9b-9ebb-4d38-a9a6-e5ad2cf78d61 type: CARD metadata: ipAddress: 64.236.140.181 loginDate: '2025-12-26T17:03:33.167Z' submitDate: '2025-12-26T17:03:57.282Z' user: dayon.alfa@gmail.com zipCode: '12656' exp: '1229' name: John Doe cardType: credit network: mastercard brand: mastercard number: 222300******9586 bin: '22230000' isSurchargeEligible: null isZipCodeEligible: null paidAt: '2025-12-26T17:04:02.537Z' applyDiscount: false status: partially-paid showBilling: true showShipping: true customValues: - key: customer_id label: Customer ID value: Ramdom123 valueLabel: '' - key: Test1 label: Test1 value: Ramdom123 valueLabel: '' createdBy: automated-testing-user@strictlyzero.com updatedBy: online activity: - code: Payment Link Created description: Payment Link was created by Automated Testing User. date: '2025-12-26T17:03:30.056Z' - code: Payment Link Shared description: Payment Link was shared via copied Link. date: '2025-12-26T17:03:30.663Z' - code: Payment Received description: |- A payment for $2.00 was received using a Mastercard ending in 9586. Transaction ID: 1226170358. date: '2025-12-26T17:04:02.554Z' sharedWith: [] deletedAt: null selectedTaxes: [] payments: - type: sale amountRefunded: 0 paymentId: 694ec0027db6ff99147df7fe paidAmount: 200 paidSurcharge: 6 paidAt: '2025-12-26T17:04:02.537Z' cardInfo: null paymentMethod: billingAddress: null last4: '9586' paymentToken: c44a0a9b-9ebb-4d38-a9a6-e5ad2cf78d61 type: CARD metadata: ipAddress: 64.236.140.181 loginDate: '2025-12-26T17:03:33.167Z' submitDate: '2025-12-26T17:03:57.282Z' user: dayon.alfa@gmail.com zipCode: '12656' exp: '1229' name: John Doe cardType: credit network: mastercard brand: mastercard number: 222300******9586 bin: '22230000' isSurchargeEligible: null isZipCodeEligible: null transactionId: '1226170358' attachments: [] createdAt: '2025-12-26T17:03:30.057Z' updatedAt: '2025-12-26T17:04:02.599Z' paymentLink: https://merchant.zerospay.com/zpay/payment-request/694ebfe2fff33e2b6034718f cardInfo: paymentToken: '' customerVaultId: '' token: '' last4: '' billingAddress: null zipCode: '' exp: '' name: '' type: '' network: '' brand: '' number: '' cardPrice: 0 cardTaxes: 0 cashPrice: 0 cashTaxes: 0 totalCardAmount: 0 totalCashAmount: 0 paymentId: 694ec0027db6ff99147df7fe transactionId: '1226170358' id: 694ebfe2fff33e2b6034718d '404': description: Not Found security: - bearer: [] summary: API view paymentLink by id tags: - Payment Links (Deprecated) delete: description: Delete a payment link (deprecated endpoint). operationId: deletePaymentLinkDeprecated parameters: - name: id required: true in: path description: Payment link ID schema: type: string - name: authorization required: true in: header schema: type: string responses: '200': description: Payment link deleted. content: application/json: examples: example1: summary: Delete PaymwentLink value: data: clientId: 60e856cce2819f4a3cfa4294 order: currency: USD amount: 100 shipping: 0 discount: 0 tax: 0 poNumber: '47498' products: [] customValues: - key: external-identifier label: External Identifier value: '356' valueLabel: '' - key: location label: Location value: florida valueLabel: Florida totalAmount: 100 active: false from: paymentLink fromId: 678a673d510ae75f40a1a0fc showBilling: true showShipping: true signedOrder: false deletedAt: '2025-02-21T01:59:21.305Z' createdBy: rosita6505@gmail.com updatedBy: rosita6505@gmail.com owner: rosita6505@gmail.com ownerGroup: null attachments: [] createdAt: '2025-01-17T14:20:45.422Z' updatedAt: '2025-02-21T01:59:21.309Z' id: 678a673d510ae75f40a1a0fe security: - bearer: [] summary: API delete paymentLink by id tags: - Payment Links (Deprecated) /v1/public/payment-link/send-by-email: post: deprecated: true description: DEPRECATED — use POST /public/202104/payment-link/send-by-email instead. operationId: sendPaymentLinkByEmailDeprecated parameters: - name: authorization required: true in: header schema: type: string requestBody: required: true content: application/json: schema: type: object properties: email: type: string paymentLinkId: type: string examples: example1: summary: Share by Email value: email: test@example.com paymentLinkId: LINK_ID responses: '200': description: Email sent. content: application/json: examples: example1: summary: Share By Email value: data: succees: true security: - bearer: [] summary: API send the payment link by email tags: - Payment Links (Deprecated) /v1/public/payment-link/send-by-sms: post: deprecated: true description: DEPRECATED — use POST /public/202104/payment-link/send-by-sms instead. operationId: sendPaymentLinkBySmsDeprecated parameters: - name: authorization required: true in: header schema: type: string requestBody: required: true content: application/json: schema: type: object properties: phoneNumber: type: string paymentLinkId: type: string examples: example1: summary: Share by SMS value: phoneNumber: 555-555-5555 paymentLinkId: LINK_ID responses: '200': description: SMS sent. content: application/json: examples: example1: summary: Share By SMS value: data: succees: true security: - bearer: [] summary: API send the payment link by sms tags: - Payment Links (Deprecated) /v1/public/payment-link/upload-attachments: post: deprecated: true description: >- DEPRECATED — use POST /public/202104/payment-link/upload-attachments instead. Upload files to attach to a payment link. Up to 10 files per request, max 25 MB total. Supported: JPG, PNG, PDF. operationId: uploadPaymentLinkAttachmentsDeprecated parameters: [] requestBody: required: true content: multipart/form-data: schema: type: object required: - file properties: file: type: array items: type: string format: binary responses: '200': description: Files uploaded. '400': description: Bad Request security: - bearer: [] summary: Upload payment link attachments tags: - Payment Links (Deprecated) /v1/public/payment-request: post: description: Create a new payment request with billing info and optional product line items. operationId: createPaymentRequest parameters: - name: authorization required: true in: header schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreatePaymentRequestDto' examples: example1: summary: Create PaymentRequest value: tax: 10 shipping: 10 amount: 200 poNumber: '235' customValues: [] currency: USD showBilling: false showShipping: false responses: '201': description: Payment request created. content: application/json: examples: example1: summary: Create PaymentRequest value: id: 639b3751881451001df993bb order: currency: USD shipping: 0 discount: 0 tax: 0.1 amount: 2 poNumber: '235' customValues: [] products: [] showBilling: false showShipping: false createdBy: integration@strictlyzero.com updatedBy: integration@strictlyzero.com createdAt: '2022-12-15T15:03:45.481Z' updatedAt: '2022-12-15T15:03:45.481Z' deletedAt: null '400': description: Bad Request '401': description: Unauthorized security: - bearer: [] summary: API create paymentRequest tags: - Payment Requests get: description: Returns a paginated list of payment requests. operationId: listPaymentRequests parameters: - name: authorization required: true in: header schema: type: string - name: limit required: false in: query schema: type: integer minimum: 1 maximum: 100 default: 25 - name: page required: false in: query schema: type: integer minimum: 1 default: 1 responses: '200': description: Paginated payment requests. content: application/json: examples: example1: summary: List PaymentRequest value: meta: count: 3 totalPages: 1 page: 1 limit: 10 data: - id: 639a094749aa3d51cf39be77 order: currency: USD shipping: 0 discount: 0 tax: 0.1 products: [] customValues: [] amount: 0.02 poNumber: '235' showBilling: false showShipping: false createdBy: integration@strictlyzero.com updatedBy: integration@strictlyzero.com createdAt: '2022-12-14T17:35:03.994Z' updatedAt: '2022-12-14T17:35:03.994Z' deletedAt: null - id: 639a99721db388674bf6ab73 order: currency: USD shipping: 0 discount: 0 tax: 0.1 products: [] customValues: [] amount: 0.02 poNumber: '235' showBilling: false showShipping: false createdBy: integration@strictlyzero.com updatedBy: integration@strictlyzero.com createdAt: '2022-12-15T03:50:10.735Z' updatedAt: '2022-12-15T03:50:10.735Z' deletedAt: null - id: 639a9b671db388674bf6ab75 order: currency: USD shipping: 0 discount: 0 tax: 0.1 products: [] customValues: [] amount: 2 poNumber: '235' showBilling: false showShipping: false createdBy: integration@strictlyzero.com updatedBy: null createdAt: '2022-12-15T03:58:31.022Z' updatedAt: '2022-12-15T13:58:13.061Z' deletedAt: null security: - bearer: [] summary: API get list of paymentRequest tags: - Payment Requests /v1/public/payment-request/{id}: get: description: Retrieve a single payment request by ID. operationId: getPaymentRequest parameters: - name: id required: true in: path description: Payment request ID schema: type: string - name: authorization required: true in: header schema: type: string responses: '200': description: Payment request returned. content: application/json: examples: example1: summary: Get PaymentRequest value: data: id: 639a9b671db388674bf6ab75 order: currency: USD shipping: 0 discount: 0 tax: 0.1 products: [] customValues: [] amount: 2 poNumber: '235' showBilling: false showShipping: false createdBy: integration@strictlyzero.com updatedBy: null createdAt: '2022-12-15T03:58:31.022Z' updatedAt: '2022-12-15T13:58:13.061Z' deletedAt: null '404': description: Not Found security: - bearer: [] summary: API view paymentRequest by id tags: - Payment Requests delete: description: Permanently delete a payment request. operationId: deletePaymentRequest parameters: - name: id required: true in: path description: Payment request ID schema: type: string - name: authorization required: true in: header schema: type: string responses: '200': description: Payment request deleted. content: application/json: schema: type: object properties: success: type: boolean '404': description: Not Found security: - bearer: [] summary: Delete a Payment request by ID tags: - Payment Requests /v1/public/plan: get: description: Returns a paginated list of recurring billing plans. operationId: listPlans parameters: - name: page required: false in: query description: Page number for paginating schema: type: number - name: limit required: false in: query description: Limit items per page schema: type: number responses: '200': description: Paginated plans list. content: application/json: examples: example1: summary: List Plan value: meta: count: 5 totalPages: 1 page: 1 limit: 25 data: - id: 64b04a08618428a3bd3e74ff payments: 0 amount: 100 untilTerminated: true name: Desde UI 50 dayFrequency: 1 monthFrequency: 0 dayOfMonth: 0 createdBy: integration@strictlyzero.com updatedBy: integration@strictlyzero.com deletedAt: null security: - bearer: [] summary: Get all plans tags: - Plans post: description: Create a new recurring billing plan. Plans are reusable templates linked to subscriptions. operationId: createPlan parameters: - name: authorization required: true in: header schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreatePublicPlanDto' examples: example1: summary: Create Plan value: payments: 3 amount: 30 name: API Plan 79 dayFrequency: 5 responses: '201': description: Plan created. content: application/json: examples: example1: summary: Create Plan value: data: id: 64b04738618428a3bd3e74e8 payments: 3 amount: 30 untilTerminated: false name: API Plan 45 dayFrequency: 5 createdBy: integration@strictlyzero.com updatedBy: integration@strictlyzero.com deletedAt: null example2: summary: Create Plan value: data: id: 64b048a327d2527853f70702 payments: 3 amount: 30 untilTerminated: false name: API Plan 79 monthFrequency: 4 dayOfMonth: 4 createdBy: integration@strictlyzero.com updatedBy: integration@strictlyzero.com deletedAt: null '400': description: Bad Request '401': description: Unauthorized security: - bearer: [] summary: Add Plan tags: - Plans /v1/public/plan/{id}: get: description: Retrieve a single billing plan by ID. operationId: getPlan parameters: - name: id required: true in: path description: Plan ID schema: type: string responses: '200': description: Plan returned. content: application/json: examples: example1: summary: Get Plan value: data: id: 64b04a08618428a3bd3e74ff payments: 0 amount: 100 untilTerminated: true name: Desde UI 50 dayFrequency: 1 monthFrequency: 0 dayOfMonth: 0 createdBy: yordankis.matos@samsystems.io updatedBy: yordankis.matos@samsystems.io deletedAt: null '404': description: Not Found security: - bearer: [] summary: Get a plan tags: - Plans delete: description: Delete a billing plan. Cannot delete plans with active subscriptions. operationId: deletePlan parameters: - name: id required: true in: path description: Plan ID schema: type: string responses: '200': description: Plan deleted. content: application/json: examples: example1: summary: Delete Plan value: data: id: 64b049e527d2527853f70712 payments: 0 amount: 100 untilTerminated: true name: Desde UI 50 dayFrequency: 1 monthFrequency: 0 dayOfMonth: 0 createdBy: yordankis.matos@samsystems.io updatedBy: yordankis.matos@samsystems.io deletedAt: null '404': description: Not Found security: - bearer: [] summary: Delete a Plan tags: - Plans /v1/public/report/pivotReport: get: description: >- Returns an aggregated snapshot report for the specified date range and report type. Use `reportType` to select the grouping dimension: - `amex-transactions` — AMEX ESA program insights - `settlement-batch` — transactions grouped by settlement batch - `daily-report` — transactions grouped by date - `location` — transactions grouped by department/location - `user-account` — transactions grouped by user account operationId: pivotReport parameters: - name: clientId required: false in: query description: Filter by clientId schema: type: string - name: startDay required: false in: query description: Filter from Start Date schema: type: string - name: endDay required: false in: query description: Filter to End Date schema: type: string - name: reportType required: false in: query description: >- Report type. Allowed values: `amex-transactions` (AMEX ESA insights), `settlement-batch` (grouped by batch), `daily-report` (grouped by date), `location` (grouped by department/location), `user-account` (grouped by user account). schema: type: string enum: - amex-transactions - settlement-batch - daily-report - location - user-account responses: '200': description: Pivot report data. content: application/json: examples: example1: summary: AMEX value: data: - date: '2022-03-07' data: - type: sale network: mastercard amount: 104 transactions: 1 surcharge: 4 baseAmount: 100 - type: sale network: visa amount: 208 transactions: 2 surcharge: 8 baseAmount: 200 totalCharges: 3.12 countCharges: 3 totalRefund: 0 countRefund: 0 totalPaidSurcharge: 0.12 baseAmount: 3 amex: 0 visa: 2.08 mastercard: 1.04 discover: 0 total: 3.12 count: 3 - date: '2022-03-08' data: - type: sale network: mastercard amount: 104 transactions: 1 surcharge: 4 baseAmount: 100 totalCharges: 1.04 countCharges: 1 totalRefund: 0 countRefund: 0 totalPaidSurcharge: 0.04 baseAmount: 1 amex: 0 visa: 0 mastercard: 1.04 discover: 0 total: 1.04 count: 1 - date: '2022-03-18' data: - type: sale network: mastercard amount: 726 transactions: 5 surcharge: 26 baseAmount: 700 totalCharges: 7.26 countCharges: 5 totalRefund: 0 countRefund: 0 totalPaidSurcharge: 0.26 baseAmount: 7 amex: 0 visa: 0 mastercard: 7.26 discover: 0 total: 7.26 count: 5 - date: '2022-03-21' data: - type: sale network: mastercard amount: 415 transactions: 3 surcharge: 15 baseAmount: 400 totalCharges: 4.15 countCharges: 3 totalRefund: 0 countRefund: 0 totalPaidSurcharge: 0.15 baseAmount: 4 amex: 0 visa: 0 mastercard: 4.15 discover: 0 total: 4.15 count: 3 - date: '2022-03-24' data: - type: sale network: visa amount: 104 transactions: 1 surcharge: 4 baseAmount: 100 totalCharges: 1.04 countCharges: 1 totalRefund: 0 countRefund: 0 totalPaidSurcharge: 0.04 baseAmount: 1 amex: 0 visa: 1.04 mastercard: 0 discover: 0 total: 1.04 count: 1 example2: summary: Snapshot Group By Settlement Batch value: data: - date: '2021-07-01 20:42:52' batchId: '490523246' processorBatchId: '490523246' data: - type: sale network: amex batchId: '490523246' processorBatchId: '490523246' amount: 107 transactions: 2 surcharge: 0 baseAmount: 107 - type: sale network: visa batchId: '490523246' processorBatchId: '490523246' amount: 31 transactions: 4 surcharge: 0 baseAmount: 31 totalCharges: 1.38 countCharges: 6 totalRefund: 0 countRefund: 0 totalPaidSurcharge: 0 baseAmount: 1.38 amex: 1.07 visa: 0.31 mastercard: 0 discover: 0 total: 1.38 count: 6 - date: '2021-07-02 20:37:32' batchId: '490704577' processorBatchId: '490704577' data: - type: sale network: amex batchId: '490704577' processorBatchId: '490704577' amount: 106 transactions: 2 surcharge: 0 baseAmount: 106 - type: sale network: visa batchId: '490704577' processorBatchId: '490704577' amount: 29 transactions: 4 surcharge: 0 baseAmount: 29 totalCharges: 1.35 countCharges: 6 totalRefund: 0 countRefund: 0 totalPaidSurcharge: 0 baseAmount: 1.35 amex: 1.06 visa: 0.29 mastercard: 0 discover: 0 total: 1.35 count: 6 - date: '2021-07-03 20:30:49' batchId: '490863792' processorBatchId: '490863792' data: - type: sale network: amex batchId: '490863792' processorBatchId: '490863792' amount: 100 transactions: 1 surcharge: 0 baseAmount: 100 - type: sale network: visa batchId: '490863792' processorBatchId: '490863792' amount: 6 transactions: 1 surcharge: 0 baseAmount: 6 totalCharges: 1.06 countCharges: 2 totalRefund: 0 countRefund: 0 totalPaidSurcharge: 0 baseAmount: 1.06 amex: 1 visa: 0.06 mastercard: 0 discover: 0 total: 1.06 count: 2 - date: '2021-07-04 20:29:07' batchId: '491004801' processorBatchId: '491004801' data: - type: sale network: amex batchId: '491004801' processorBatchId: '491004801' amount: 100 transactions: 1 surcharge: 0 baseAmount: 100 - type: sale network: visa batchId: '491004801' processorBatchId: '491004801' amount: 6 transactions: 1 surcharge: 0 baseAmount: 6 totalCharges: 1.06 countCharges: 2 totalRefund: 0 countRefund: 0 totalPaidSurcharge: 0 baseAmount: 1.06 amex: 1 visa: 0.06 mastercard: 0 discover: 0 total: 1.06 count: 2 - date: '2021-07-05 20:33:03' batchId: '491152625' processorBatchId: '491152625' data: - type: sale network: visa batchId: '491152625' processorBatchId: '491152625' amount: 6 transactions: 1 surcharge: 0 baseAmount: 6 totalCharges: 0.06 countCharges: 1 totalRefund: 0 countRefund: 0 totalPaidSurcharge: 0 baseAmount: 0.06 amex: 0 visa: 0.06 mastercard: 0 discover: 0 total: 0.06 count: 1 - date: '2021-07-06 20:37:22' batchId: '491326585' processorBatchId: '491326585' data: - type: sale network: visa batchId: '491326585' processorBatchId: '491326585' amount: 13 transactions: 2 surcharge: 0 baseAmount: 13 - type: sale network: amex batchId: '491326585' processorBatchId: '491326585' amount: 57 transactions: 4 surcharge: 1 baseAmount: 56 totalCharges: 0.7 countCharges: 6 totalRefund: 0 countRefund: 0 totalPaidSurcharge: 0.01 baseAmount: 0.69 amex: 0.57 visa: 0.13 mastercard: 0 discover: 0 total: 0.7 count: 6 - date: '2021-07-07 20:36:49' batchId: '491509923' processorBatchId: '491509923' data: - type: sale network: visa batchId: '491509923' processorBatchId: '491509923' amount: 78 transactions: 4 surcharge: 2 baseAmount: 76 - type: sale network: amex batchId: '491509923' processorBatchId: '491509923' amount: 110 transactions: 2 surcharge: 4 baseAmount: 106 totalCharges: 1.88 countCharges: 6 totalRefund: 0 countRefund: 0 totalPaidSurcharge: 0.06 baseAmount: 1.82 amex: 1.1 visa: 0.78 mastercard: 0 discover: 0 total: 1.88 count: 6 - date: '2021-07-08 20:36:27' batchId: '491696779' processorBatchId: '491696779' data: - type: refund network: amex batchId: '491696779' processorBatchId: '491696779' amount: 62 transactions: 1 surcharge: 2 baseAmount: 60 - type: refund network: visa batchId: '491696779' processorBatchId: '491696779' amount: 5 transactions: 1 surcharge: 0 baseAmount: 5 - type: sale network: amex batchId: '491696779' processorBatchId: '491696779' amount: 237 transactions: 9 surcharge: 7 baseAmount: 230 - type: sale network: visa batchId: '491696779' processorBatchId: '491696779' amount: 214 transactions: 9 surcharge: 6 baseAmount: 208 totalCharges: 4.51 countCharges: 18 totalRefund: 0.67 countRefund: 2 totalPaidSurcharge: 0.15 baseAmount: 3.69 amex: 1.75 visa: 2.09 mastercard: 0 discover: 0 total: 3.84 count: 20 - date: '2021-07-09 20:36:48' batchId: '491879122' processorBatchId: '491879122' data: - type: sale network: amex batchId: '491879122' processorBatchId: '491879122' amount: 58 transactions: 2 surcharge: 2 baseAmount: 56 - type: sale network: visa batchId: '491879122' processorBatchId: '491879122' amount: 200 transactions: 4 surcharge: 7 baseAmount: 193 totalCharges: 2.58 countCharges: 6 totalRefund: 0 countRefund: 0 totalPaidSurcharge: 0.09 baseAmount: 2.49 amex: 0.58 visa: 2 mastercard: 0 discover: 0 total: 2.58 count: 6 - date: '2021-07-10 20:31:04' batchId: '492038062' processorBatchId: '492038062' data: - type: sale network: visa batchId: '492038062' processorBatchId: '492038062' amount: 6 transactions: 1 surcharge: 0 baseAmount: 6 - type: sale network: amex batchId: '492038062' processorBatchId: '492038062' amount: 6 transactions: 1 surcharge: 0 baseAmount: 6 totalCharges: 0.12 countCharges: 2 totalRefund: 0 countRefund: 0 totalPaidSurcharge: 0 baseAmount: 0.12 amex: 0.06 visa: 0.06 mastercard: 0 discover: 0 total: 0.12 count: 2 - date: '2021-07-11 20:29:27' batchId: '492185235' processorBatchId: '492185235' data: - type: sale network: visa batchId: '492185235' processorBatchId: '492185235' amount: 6 transactions: 1 surcharge: 0 baseAmount: 6 - type: sale network: amex batchId: '492185235' processorBatchId: '492185235' amount: 6 transactions: 1 surcharge: 0 baseAmount: 6 totalCharges: 0.12 countCharges: 2 totalRefund: 0 countRefund: 0 totalPaidSurcharge: 0 baseAmount: 0.12 amex: 0.06 visa: 0.06 mastercard: 0 discover: 0 total: 0.12 count: 2 - date: '2021-07-12 20:37:12' batchId: '492354218' processorBatchId: '492354218' data: - type: sale network: amex batchId: '492354218' processorBatchId: '492354218' amount: 6 transactions: 1 surcharge: 0 baseAmount: 6 - type: sale network: visa batchId: '492354218' processorBatchId: '492354218' amount: 6 transactions: 1 surcharge: 0 baseAmount: 6 totalCharges: 0.12 countCharges: 2 totalRefund: 0 countRefund: 0 totalPaidSurcharge: 0 baseAmount: 0.12 amex: 0.06 visa: 0.06 mastercard: 0 discover: 0 total: 0.12 count: 2 - date: '2021-07-13 20:36:37' batchId: '492536924' processorBatchId: '492536924' data: - type: sale network: visa batchId: '492536924' processorBatchId: '492536924' amount: 6 transactions: 1 surcharge: 0 baseAmount: 6 - type: sale network: amex batchId: '492536924' processorBatchId: '492536924' amount: 6 transactions: 1 surcharge: 0 baseAmount: 6 totalCharges: 0.12 countCharges: 2 totalRefund: 0 countRefund: 0 totalPaidSurcharge: 0 baseAmount: 0.12 amex: 0.06 visa: 0.06 mastercard: 0 discover: 0 total: 0.12 count: 2 - date: '2021-07-14 20:36:13' batchId: '492723469' processorBatchId: '492723469' data: - type: sale network: visa batchId: '492723469' processorBatchId: '492723469' amount: 276 transactions: 8 surcharge: 10 baseAmount: 266 totalCharges: 2.76 countCharges: 8 totalRefund: 0 countRefund: 0 totalPaidSurcharge: 0.1 baseAmount: 2.66 amex: 0 visa: 2.76 mastercard: 0 discover: 0 total: 2.76 count: 8 - date: '2021-07-15 20:37:53' batchId: '492910934' processorBatchId: '492910934' data: - type: sale network: visa batchId: '492910934' processorBatchId: '492910934' amount: 4 transactions: 2 surcharge: 0 baseAmount: 4 - type: refund network: visa batchId: '492910934' processorBatchId: '492910934' amount: 2 transactions: 2 surcharge: 0 baseAmount: 2 - type: sale network: visa batchId: '492910934' processorBatchId: '492910934' amount: 71 transactions: 5 surcharge: 2 baseAmount: 69 totalCharges: 0.75 countCharges: 7 totalRefund: 0.02 countRefund: 2 totalPaidSurcharge: 0.02 baseAmount: 0.71 amex: 0 visa: 0.73 mastercard: 0 discover: 0 total: 0.73 count: 9 - date: '2021-07-16 20:38:17' batchId: '493095089' processorBatchId: '493095089' data: - type: sale network: visa batchId: '493095089' processorBatchId: '493095089' amount: 233 transactions: 8 surcharge: 7 baseAmount: 226 - type: refund network: visa batchId: '493095089' processorBatchId: '493095089' amount: 6 transactions: 1 surcharge: 0 baseAmount: 6 totalCharges: 2.33 countCharges: 8 totalRefund: 0.06 countRefund: 1 totalPaidSurcharge: 0.07 baseAmount: 2.2 amex: 0 visa: 2.27 mastercard: 0 discover: 0 total: 2.27 count: 9 - date: '2021-07-17 20:30:36' batchId: '493256408' processorBatchId: '493256408' data: - type: sale network: visa batchId: '493256408' processorBatchId: '493256408' amount: 6 transactions: 1 surcharge: 0 baseAmount: 6 totalCharges: 0.06 countCharges: 1 totalRefund: 0 countRefund: 0 totalPaidSurcharge: 0 baseAmount: 0.06 amex: 0 visa: 0.06 mastercard: 0 discover: 0 total: 0.06 count: 1 - date: '2021-07-18 20:28:32' batchId: '493400496' processorBatchId: '493400496' data: - type: sale network: visa batchId: '493400496' processorBatchId: '493400496' amount: 6 transactions: 1 surcharge: 0 baseAmount: 6 totalCharges: 0.06 countCharges: 1 totalRefund: 0 countRefund: 0 totalPaidSurcharge: 0 baseAmount: 0.06 amex: 0 visa: 0.06 mastercard: 0 discover: 0 total: 0.06 count: 1 - date: '2021-07-19 20:36:22' batchId: '493569026' processorBatchId: '493569026' data: - type: sale network: amex batchId: '493569026' processorBatchId: '493569026' amount: 194 transactions: 2 surcharge: 7 baseAmount: 187 - type: sale network: visa batchId: '493569026' processorBatchId: '493569026' amount: 70 transactions: 3 surcharge: 2 baseAmount: 68 - type: refund network: visa batchId: '493569026' processorBatchId: '493569026' amount: 9 transactions: 1 surcharge: 0 baseAmount: 9 totalCharges: 2.64 countCharges: 5 totalRefund: 0.09 countRefund: 1 totalPaidSurcharge: 0.09 baseAmount: 2.46 amex: 1.94 visa: 0.61 mastercard: 0 discover: 0 total: 2.55 count: 6 - date: '2021-07-20 20:36:32' batchId: '493752972' processorBatchId: '493752972' data: - type: sale network: visa batchId: '493752972' processorBatchId: '493752972' amount: 6 transactions: 1 surcharge: 0 baseAmount: 6 totalCharges: 0.06 countCharges: 1 totalRefund: 0 countRefund: 0 totalPaidSurcharge: 0 baseAmount: 0.06 amex: 0 visa: 0.06 mastercard: 0 discover: 0 total: 0.06 count: 1 - date: '2021-07-21 20:35:45' batchId: '493938693' processorBatchId: '493938693' data: - type: sale network: visa batchId: '493938693' processorBatchId: '493938693' amount: 178 transactions: 5 surcharge: 5 baseAmount: 173 totalCharges: 1.78 countCharges: 5 totalRefund: 0 countRefund: 0 totalPaidSurcharge: 0.05 baseAmount: 1.73 amex: 0 visa: 1.78 mastercard: 0 discover: 0 total: 1.78 count: 5 - date: '2021-07-22 20:35:25' batchId: '494123598' processorBatchId: '494123598' data: - type: sale network: amex batchId: '494123598' processorBatchId: '494123598' amount: 204 transactions: 2 surcharge: 4 baseAmount: 200 - type: sale network: visa batchId: '494123598' processorBatchId: '494123598' amount: 390 transactions: 5 surcharge: 7 baseAmount: 383 totalCharges: 5.94 countCharges: 7 totalRefund: 0 countRefund: 0 totalPaidSurcharge: 0.11 baseAmount: 5.83 amex: 2.04 visa: 3.9 mastercard: 0 discover: 0 total: 5.94 count: 7 - date: '2021-07-23 20:35:44' batchId: '494305049' processorBatchId: '494305049' data: - type: refund network: visa batchId: '494305049' processorBatchId: '494305049' amount: 112 transactions: 3 surcharge: 2 baseAmount: 110 - type: sale network: visa batchId: '494305049' processorBatchId: '494305049' amount: 127 transactions: 4 surcharge: 2 baseAmount: 125 totalCharges: 1.27 countCharges: 4 totalRefund: 1.12 countRefund: 3 totalPaidSurcharge: 0.04 baseAmount: 0.11 amex: 0 visa: 0.15 mastercard: 0 discover: 0 total: 0.15 count: 7 - date: '2021-07-24 20:29:21' batchId: '494465148' processorBatchId: '494465148' data: - type: sale network: visa batchId: '494465148' processorBatchId: '494465148' amount: 6 transactions: 1 surcharge: 0 baseAmount: 6 totalCharges: 0.06 countCharges: 1 totalRefund: 0 countRefund: 0 totalPaidSurcharge: 0 baseAmount: 0.06 amex: 0 visa: 0.06 mastercard: 0 discover: 0 total: 0.06 count: 1 - date: '2021-07-25 20:28:51' batchId: '494609967' processorBatchId: '494609967' data: - type: sale network: visa batchId: '494609967' processorBatchId: '494609967' amount: 6 transactions: 1 surcharge: 0 baseAmount: 6 totalCharges: 0.06 countCharges: 1 totalRefund: 0 countRefund: 0 totalPaidSurcharge: 0 baseAmount: 0.06 amex: 0 visa: 0.06 mastercard: 0 discover: 0 total: 0.06 count: 1 - date: '2021-07-26 20:35:49' batchId: '494778702' processorBatchId: '494778702' data: - type: refund network: amex batchId: '494778702' processorBatchId: '494778702' amount: 104 transactions: 1 surcharge: 4 baseAmount: 100 - type: sale network: amex batchId: '494778702' processorBatchId: '494778702' amount: 104 transactions: 1 surcharge: 4 baseAmount: 100 - type: sale network: visa batchId: '494778702' processorBatchId: '494778702' amount: 89 transactions: 2 surcharge: 3 baseAmount: 86 totalCharges: 1.93 countCharges: 3 totalRefund: 1.04 countRefund: 1 totalPaidSurcharge: 0.11 baseAmount: 0.78 amex: 0 visa: 0.89 mastercard: 0 discover: 0 total: 0.89 count: 4 - date: '2021-07-27 20:34:48' batchId: '494962223' processorBatchId: '494962223' data: - type: sale network: amex batchId: '494962223' processorBatchId: '494962223' amount: 10 transactions: 1 surcharge: 0 baseAmount: 10 - type: sale network: visa batchId: '494962223' processorBatchId: '494962223' amount: 15 transactions: 2 surcharge: 0 baseAmount: 15 totalCharges: 0.25 countCharges: 3 totalRefund: 0 countRefund: 0 totalPaidSurcharge: 0 baseAmount: 0.25 amex: 0.1 visa: 0.15 mastercard: 0 discover: 0 total: 0.25 count: 3 - date: '2021-07-28 20:35:50' batchId: '495147141' processorBatchId: '495147141' data: - type: sale network: amex batchId: '495147141' processorBatchId: '495147141' amount: 21 transactions: 2 surcharge: 0 baseAmount: 21 - type: refund network: visa batchId: '495147141' processorBatchId: '495147141' amount: 7 transactions: 1 surcharge: 0 baseAmount: 7 - type: sale network: visa batchId: '495147141' processorBatchId: '495147141' amount: 64 transactions: 3 surcharge: 2 baseAmount: 62 totalCharges: 0.85 countCharges: 5 totalRefund: 0.07 countRefund: 1 totalPaidSurcharge: 0.02 baseAmount: 0.76 amex: 0.21 visa: 0.57 mastercard: 0 discover: 0 total: 0.78 count: 6 - date: '2021-07-29 20:36:27' batchId: '495331295' processorBatchId: '495331295' data: - type: sale network: amex batchId: '495331295' processorBatchId: '495331295' amount: 1 transactions: 1 surcharge: 0 baseAmount: 1 - type: sale network: visa batchId: '495331295' processorBatchId: '495331295' amount: 83 transactions: 1 surcharge: 3 baseAmount: 80 - type: sale network: visa batchId: '495331295' processorBatchId: '495331295' amount: 8 transactions: 2 surcharge: 0 baseAmount: 8 totalCharges: 0.92 countCharges: 4 totalRefund: 0 countRefund: 0 totalPaidSurcharge: 0.03 baseAmount: 0.89 amex: 0.01 visa: 0.91 mastercard: 0 discover: 0 total: 0.92 count: 4 - date: '2021-07-30 20:37:11' batchId: '495514028' processorBatchId: '495514028' data: - type: sale network: amex batchId: '495514028' processorBatchId: '495514028' amount: 323 transactions: 5 surcharge: 12 baseAmount: 311 - type: sale network: visa batchId: '495514028' processorBatchId: '495514028' amount: 166 transactions: 6 surcharge: 5 baseAmount: 161 totalCharges: 4.89 countCharges: 11 totalRefund: 0 countRefund: 0 totalPaidSurcharge: 0.17 baseAmount: 4.72 amex: 3.23 visa: 1.66 mastercard: 0 discover: 0 total: 4.89 count: 11 - date: '2021-07-31 20:30:34' batchId: '495677805' processorBatchId: '495677805' data: - type: sale network: visa batchId: '495677805' processorBatchId: '495677805' amount: 6 transactions: 1 surcharge: 0 baseAmount: 6 totalCharges: 0.06 countCharges: 1 totalRefund: 0 countRefund: 0 totalPaidSurcharge: 0 baseAmount: 0.06 amex: 0 visa: 0.06 mastercard: 0 discover: 0 total: 0.06 count: 1 - date: '2021-07-01 08:37:28' batchId: '715686702' processorBatchId: '' data: - type: refund network: visa batchId: '715686702' processorBatchId: '' amount: 200000 transactions: 1 surcharge: 0 baseAmount: 200000 - type: sale network: visa batchId: '715686702' processorBatchId: '' amount: 49954 transactions: 1 surcharge: 0 baseAmount: 49954 totalCharges: 499.54 countCharges: 1 totalRefund: 2000 countRefund: 1 totalPaidSurcharge: 0 baseAmount: -1500.46 amex: 0 visa: -1500.46 mastercard: 0 discover: 0 total: -1500.46 count: 2 - date: '2021-07-01 17:23:00' batchId: '716014102' processorBatchId: '' data: - type: sale network: visa batchId: '716014102' processorBatchId: '' amount: 1 transactions: 1 surcharge: 0 baseAmount: 1 totalCharges: 0.01 countCharges: 1 totalRefund: 0 countRefund: 0 totalPaidSurcharge: 0 baseAmount: 0.01 amex: 0 visa: 0.01 mastercard: 0 discover: 0 total: 0.01 count: 1 example3: summary: Snapshot Group By Department value: data: - date: null location: No Department data: - type: sale network: mastercard location: No Department amount: 1349 transactions: 10 surcharge: 49 baseAmount: 1300 - type: sale network: visa location: No Department amount: 208 transactions: 2 surcharge: 8 baseAmount: 200 totalCharges: 15.57 countCharges: 12 totalRefund: 0 countRefund: 0 totalPaidSurcharge: 0.57 baseAmount: 15 amex: 0 visa: 2.08 mastercard: 13.49 discover: 0 total: 15.57 count: 12 - date: null location: Not a Terminal Payment data: - type: sale network: visa location: Not a Terminal Payment amount: 104 transactions: 1 surcharge: 4 baseAmount: 100 totalCharges: 1.04 countCharges: 1 totalRefund: 0 countRefund: 0 totalPaidSurcharge: 0.04 baseAmount: 1 amex: 0 visa: 1.04 mastercard: 0 discover: 0 total: 1.04 count: 1 '401': description: Unauthorized security: - bearer: [] summary: Get pivot report tags: - Reports /v1/public/report/deposit: get: description: >- Returns a list of deposits showing how much was funded for the given date range and MID (Merchant ID). Use `startDay` and `endDay` to filter by date range (format: YYYY-MM-DD). Provide `mid` to filter by a specific merchant account. operationId: depositReport parameters: - name: startDay required: false in: query description: Filter from Start Date schema: type: string - name: endDay required: false in: query description: Filter to End Date schema: type: string - name: page required: false in: query description: Page number for paginating schema: type: number - name: limit required: false in: query description: Limit items per page schema: type: number - name: mid required: false in: query description: MID (Merchant ID) to filter deposits. Required to retrieve meaningful results. schema: type: string responses: '200': description: Deposit report data. content: application/json: examples: example1: summary: Deposits value: data: - depositId: '121100000334809' date: '2021-07-31' paymentDate: '2021-07-30T00:00:00.000Z' transactionsCount: 11 grossAmount: 489 fundAmt: 472 - depositId: '121000000335888' date: '2021-07-30' paymentDate: '2021-07-29T00:00:00.000Z' transactionsCount: 4 grossAmount: 92 fundAmt: 89 - depositId: '120900000332726' date: '2021-07-29' paymentDate: '2021-07-28T00:00:00.000Z' transactionsCount: 6 grossAmount: 78 fundAmt: 75 meta: count: 3 page: 1 totals: grossAmount: 659 fundAmt: 636 '401': description: Unauthorized security: - bearer: [] summary: Get deposit report tags: - Reports /v1/public/report/deposit-details: get: description: >- Returns line-item transaction detail for a specific deposit batch. Provide the `paymentReference` value from the deposit report to drill into individual transactions within that batch. operationId: depositDetails parameters: - name: paymentReference required: false in: query description: >- Payment reference from the deposit report. Required to retrieve deposit line-item details for a specific batch. schema: type: string - name: page required: false in: query description: Page number for paginating schema: type: number - name: limit required: false in: query description: Limit items per page schema: type: number responses: '200': description: Deposit detail rows. content: application/json: examples: example1: summary: Deposit Details value: data: - _id: 610aea09adf457001c6e4c55 processed: true isoName: Prospay Inc. notifiedDate: '2021-07-31T00:00:00.000Z' fileName: GIR1.PROSPAYZERO.XF00.017EN041854FUND20210731 paymentReference: '121100000334809' paymentDate: '2021-07-30T00:00:00.000Z' accountNumber: '*********8521' routingNumber: '00263191387' fundAmt: 472 batchReference: '28211229617' batchType: D customerBatchReference: '00000000003' customerName: PROSPAY INC merchantNumber: '08038133842' externalMid: '8038133842' storeNumber: '' chain: '00000' batchAmt: 489 amount: 83 surchgAmount: 0 convnceAmt: 0 cardType: '006' chargeType: '01602' chargeTypeDescription: V COMM CNP - BUS TIER 1 cardPlan: VISA cardNo: 424631******9986 chkNum: '' transactionDate: '2021-07-30T00:00:00.000Z' settlementDate: '2021-07-30T00:00:00.000Z' authorizationCode: 04719G chargebackControlNo: '' rocText: '' trnAci: W cardSchemeRef: '461211677034336' trnRefNum: '28211229622' settlementMethod: ACH currencyCode: USD cbAcqRefId: '' chgbkRsnCode: '' chgbkRsnDesc: '' merRef: '00730184823' purchId: '003073020450005' custCod: '003073020450005' trnArn: '24755421211282112296227' termId: '0005420000008038133842' entNum: '41854' createdAt: '2021-08-03T19:42:42.788Z' updatedAt: '2021-08-03T19:42:42.788Z' rate: 3.3816 perItem: 0 fee: 2.806728 offsetFee: 0.0083 baseAmount: 80 card: number: 424631******9986 network: visa exp: '1024' type: credit last4: '9986' vaultId: 60dc6d55017076001d27d4a0 name: Saday transactionAt: '2021-07-30T18:48:24.178Z' __v: 0 - _id: 610aea09adf457001c6e4c57 processed: true isoName: Prospay Inc. notifiedDate: '2021-07-31T00:00:00.000Z' fileName: GIR1.PROSPAYZERO.XF00.017EN041854FUND20210731 paymentReference: '121100000334809' paymentDate: '2021-07-30T00:00:00.000Z' accountNumber: '*********8521' routingNumber: '00263191387' fundAmt: 472 batchReference: '28211229617' batchType: D customerBatchReference: '00000000003' customerName: PROSPAY INC merchantNumber: '08038133842' externalMid: '8038133842' storeNumber: '' chain: '00000' batchAmt: 489 amount: 5 surchgAmount: 0 convnceAmt: 0 cardType: '006' chargeType: '01602' chargeTypeDescription: V COMM CNP - BUS TIER 1 cardPlan: VISA cardNo: 424631******9986 chkNum: '' transactionDate: '2021-07-30T00:00:00.000Z' settlementDate: '2021-07-30T00:00:00.000Z' authorizationCode: 06513G chargebackControlNo: '' rocText: '' trnAci: W cardSchemeRef: '461211699504285' trnRefNum: '28211229624' settlementMethod: ACH currencyCode: USD cbAcqRefId: '' chgbkRsnCode: '' chgbkRsnDesc: '' merRef: '00730192550' purchId: '003073020450007' custCod: '003073020450007' trnArn: '24755421211282112296243' termId: '0005420000008038133842' entNum: '41854' createdAt: '2021-08-03T19:42:42.788Z' updatedAt: '2021-08-03T19:42:42.788Z' rate: 3.3816 perItem: 0 fee: 0.16908 offsetFee: 0.0005 baseAmount: 5 card: number: 424631******9986 network: visa exp: '1024' paymentToken: bn42UnmP-Zpp3T3-sAekUk-EatmMhsvb753 type: credit last4: '9986' name: 'Saday Duran ' transactionAt: '2021-07-30T19:25:50.651Z' __v: 0 - _id: 610aea0aadf457001c6e4c60 processed: true isoName: Prospay Inc. notifiedDate: '2021-07-31T00:00:00.000Z' fileName: GIR1.PROSPAYZERO.XF00.017EN041854FUND20210731 paymentReference: '121100000334809' paymentDate: '2021-07-30T00:00:00.000Z' accountNumber: '*********8521' routingNumber: '00263191387' fundAmt: 472 batchReference: '28211229617' batchType: D customerBatchReference: '00000000003' customerName: PROSPAY INC merchantNumber: '08038133842' externalMid: '8038133842' storeNumber: '' chain: '00000' batchAmt: 489 amount: 56 surchgAmount: 0 convnceAmt: 0 cardType: '006' chargeType: '01602' chargeTypeDescription: V COMM CNP - BUS TIER 1 cardPlan: VISA cardNo: 424631******9986 chkNum: '' transactionDate: '2021-07-30T00:00:00.000Z' settlementDate: '2021-07-30T00:00:00.000Z' authorizationCode: 04487G chargebackControlNo: '' rocText: '' trnAci: W cardSchemeRef: '381211694964582' trnRefNum: '28211229623' settlementMethod: ACH currencyCode: USD cbAcqRefId: '' chgbkRsnCode: '' chgbkRsnDesc: '' merRef: '00730191816' purchId: '003073020450006' custCod: '003073020450006' trnArn: '24755421211282112296235' termId: '0005420000008038133842' entNum: '41854' createdAt: '2021-08-03T19:42:42.787Z' updatedAt: '2021-08-03T19:42:42.787Z' rate: 3.3816 perItem: 0 fee: 1.8936960000000003 offsetFee: 0.005600000000000001 baseAmount: 54 card: number: 424631******9986 network: visa exp: '1024' paymentToken: nAx7JCPe-TP93h9-37sE3a-q2ZH7jUUH9Ky type: credit last4: '9986' name: 'Saday Duran ' transactionAt: '2021-07-30T19:18:16.392Z' __v: 0 - _id: 610aea0aadf457001c6e4c62 processed: true isoName: Prospay Inc. notifiedDate: '2021-07-31T00:00:00.000Z' fileName: GIR1.PROSPAYZERO.XF00.017EN041854FUND20210731 paymentReference: '121100000334809' paymentDate: '2021-07-30T00:00:00.000Z' accountNumber: '*********8521' routingNumber: '00263191387' fundAmt: 472 batchReference: '28211229617' batchType: D customerBatchReference: '00000000003' customerName: PROSPAY INC merchantNumber: '08038133842' externalMid: '8038133842' storeNumber: '' chain: '00000' batchAmt: 489 amount: 105 surchgAmount: 0 convnceAmt: 0 cardType: '110' chargeType: '10039' chargeTypeDescription: AMEX B2B/WHOLESALE 1 CNP cardPlan: AEXP cardNo: 371557*****2030 chkNum: '' transactionDate: '2021-07-30T00:00:00.000Z' settlementDate: '2021-07-30T00:00:00.000Z' authorizationCode: '180081' chargebackControlNo: '' rocText: '' trnAci: A cardSchemeRef: '002691868055074' trnRefNum: '28211229627' settlementMethod: ACH currencyCode: USD cbAcqRefId: '' chgbkRsnCode: '' chgbkRsnDesc: '' merRef: '00730212603' purchId: '' custCod: '' trnArn: 0000000000028211229627X termId: '0005420000008038133842' entNum: '41854' createdAt: '2021-08-03T19:42:42.727Z' updatedAt: '2021-08-03T19:42:42.727Z' rate: 3.3816 perItem: 0 fee: 3.5506800000000003 offsetFee: 0.0105 baseAmount: 101 card: name: Demo Card number: 411111******1111 paymentToken: V5Te5m5D-hb5FZ4-mX2te8-7tfApNRx3pKr vaultId: 60d481560e64b7001ca3efdd type: credit last4: '2030' network: amex transactionAt: '2021-07-30T21:26:04.056Z' __v: 0 - _id: 610aea0aadf457001c6e4c64 processed: true isoName: Prospay Inc. notifiedDate: '2021-07-31T00:00:00.000Z' fileName: GIR1.PROSPAYZERO.XF00.017EN041854FUND20210731 paymentReference: '121100000334809' paymentDate: '2021-07-30T00:00:00.000Z' accountNumber: '*********8521' routingNumber: '00263191387' fundAmt: 472 batchReference: '28211229617' batchType: D customerBatchReference: '00000000003' customerName: PROSPAY INC merchantNumber: '08038133842' externalMid: '8038133842' storeNumber: '' chain: '00000' batchAmt: 489 amount: 1 surchgAmount: 0 convnceAmt: 0 cardType: '110' chargeType: '10039' chargeTypeDescription: AMEX B2B/WHOLESALE 1 CNP cardPlan: AEXP cardNo: 371557*****2030 chkNum: '' transactionDate: '2021-07-30T00:00:00.000Z' settlementDate: '2021-07-30T00:00:00.000Z' authorizationCode: '166199' chargebackControlNo: '' rocText: '' trnAci: A cardSchemeRef: '002689581227079' trnRefNum: '28211229621' settlementMethod: ACH currencyCode: USD cbAcqRefId: '' chgbkRsnCode: '' chgbkRsnDesc: '' merRef: '00730184547' purchId: '' custCod: '' trnArn: 0000000000028211229621X termId: '0005420000008038133842' entNum: '41854' createdAt: '2021-08-03T19:42:42.727Z' updatedAt: '2021-08-03T19:42:42.727Z' rate: 3.3816 perItem: 0 fee: 0.033816 offsetFee: 0.0001 baseAmount: 1 card: number: 371557*****2030 network: amex exp: '0122' type: credit last4: '2030' vaultId: 60d481560e64b7001ca3efdd name: Randy Pereira transactionAt: '2021-07-30T18:45:48.673Z' __v: 0 - _id: 610aea0aadf457001c6e4c66 processed: true isoName: Prospay Inc. notifiedDate: '2021-07-31T00:00:00.000Z' fileName: GIR1.PROSPAYZERO.XF00.017EN041854FUND20210731 paymentReference: '121100000334809' paymentDate: '2021-07-30T00:00:00.000Z' accountNumber: '*********8521' routingNumber: '00263191387' fundAmt: 472 batchReference: '28211229617' batchType: D customerBatchReference: '00000000003' customerName: PROSPAY INC merchantNumber: '08038133842' externalMid: '8038133842' storeNumber: '' chain: '00000' batchAmt: 489 amount: 6 surchgAmount: 0 convnceAmt: 0 cardType: '006' chargeType: '01602' chargeTypeDescription: V COMM CNP - BUS TIER 1 cardPlan: VISA cardNo: 424631******9986 chkNum: '' transactionDate: '2021-07-30T00:00:00.000Z' settlementDate: '2021-07-30T00:00:00.000Z' authorizationCode: 05164G chargebackControlNo: '' rocText: '' trnAci: W cardSchemeRef: '381211297055215' trnRefNum: '28211229619' settlementMethod: ACH currencyCode: USD cbAcqRefId: '' chgbkRsnCode: '' chgbkRsnDesc: '' merRef: '00730081505' purchId: '003073020450002' custCod: '003073020450002' trnArn: '24755421211282112296193' termId: '0005420000008038133842' entNum: '41854' createdAt: '2021-08-03T19:42:42.727Z' updatedAt: '2021-08-03T19:42:42.727Z' rate: 3.3816 perItem: 0 fee: 0.202896 offsetFee: 0.0006 baseAmount: 6 card: vaultId: 60dc6d55017076001d27d4a0 name: Saday number: 424631******9986 type: credit paymentToken: K257Rqt7-3aM8HF-mB6vgw-y34U5A5Rn949 exp: '1024' network: visa last4: '9986' transactionAt: '2021-07-30T08:15:05.628Z' __v: 0 - _id: 610aea0aadf457001c6e4c68 processed: true isoName: Prospay Inc. notifiedDate: '2021-07-31T00:00:00.000Z' fileName: GIR1.PROSPAYZERO.XF00.017EN041854FUND20210731 paymentReference: '121100000334809' paymentDate: '2021-07-30T00:00:00.000Z' accountNumber: '*********8521' routingNumber: '00263191387' fundAmt: 472 batchReference: '28211229617' batchType: D customerBatchReference: '00000000003' customerName: PROSPAY INC merchantNumber: '08038133842' externalMid: '8038133842' storeNumber: '' chain: '00000' batchAmt: 489 amount: 7 surchgAmount: 0 convnceAmt: 0 cardType: '006' chargeType: '01602' chargeTypeDescription: V COMM CNP - BUS TIER 1 cardPlan: VISA cardNo: 424631******9986 chkNum: '' transactionDate: '2021-07-30T00:00:00.000Z' settlementDate: '2021-07-30T00:00:00.000Z' authorizationCode: 05129G chargebackControlNo: '' rocText: '' trnAci: W cardSchemeRef: '301211297041676' trnRefNum: '28211229618' settlementMethod: ACH currencyCode: USD cbAcqRefId: '' chgbkRsnCode: '' chgbkRsnDesc: '' merRef: '00730081504' purchId: '003073020450001' custCod: '003073020450001' trnArn: '24755421211282112296185' termId: '0005420000008038133842' entNum: '41854' createdAt: '2021-08-03T19:42:42.727Z' updatedAt: '2021-08-03T19:42:42.727Z' rate: 3.3816 perItem: 0 fee: 0.23671200000000003 offsetFee: 0.0007000000000000001 baseAmount: 7 card: vaultId: 60dc6d55017076001d27d4a0 name: Saday number: 424631******9986 type: credit paymentToken: K257Rqt7-3aM8HF-mB6vgw-y34U5A5Rn949 exp: '1024' network: visa last4: '9986' transactionAt: '2021-07-30T08:15:04.474Z' __v: 0 - _id: 610aea0aadf457001c6e4c6a processed: true isoName: Prospay Inc. notifiedDate: '2021-07-31T00:00:00.000Z' fileName: GIR1.PROSPAYZERO.XF00.017EN041854FUND20210731 paymentReference: '121100000334809' paymentDate: '2021-07-30T00:00:00.000Z' accountNumber: '*********8521' routingNumber: '00263191387' fundAmt: 472 batchReference: '28211229617' batchType: D customerBatchReference: '00000000003' customerName: PROSPAY INC merchantNumber: '08038133842' externalMid: '8038133842' storeNumber: '' chain: '00000' batchAmt: 489 amount: 7 surchgAmount: 0 convnceAmt: 0 cardType: '110' chargeType: '10039' chargeTypeDescription: AMEX B2B/WHOLESALE 1 CNP cardPlan: AEXP cardNo: 371557*****2030 chkNum: '' transactionDate: '2021-07-30T00:00:00.000Z' settlementDate: '2021-07-30T00:00:00.000Z' authorizationCode: '124516' chargebackControlNo: '' rocText: '' trnAci: A cardSchemeRef: '002683264262073' trnRefNum: '28211229620' settlementMethod: ACH currencyCode: USD cbAcqRefId: '' chgbkRsnCode: '' chgbkRsnDesc: '' merRef: '00730081508' purchId: '' custCod: '' trnArn: 0000000000028211229620X termId: '0005420000008038133842' entNum: '41854' createdAt: '2021-08-03T19:42:42.727Z' updatedAt: '2021-08-03T19:42:42.727Z' rate: 3.3816 perItem: 0 fee: 0.23671200000000003 offsetFee: 0.0007000000000000001 baseAmount: 7 card: vaultId: 61002d197f6d1c001c16e463 name: Ernesto M number: 371557*****2030 network: amex exp: '0122' paymentToken: 29Wq4T66-WP7pwG-74QWn5-PvsU26az9Kg8 last4: '2030' type: credit transactionAt: '2021-07-30T08:15:08.813Z' __v: 0 - _id: 610aea0aadf457001c6e4c6e processed: true isoName: Prospay Inc. notifiedDate: '2021-07-31T00:00:00.000Z' fileName: GIR1.PROSPAYZERO.XF00.017EN041854FUND20210731 paymentReference: '121100000334809' paymentDate: '2021-07-30T00:00:00.000Z' accountNumber: '*********8521' routingNumber: '00263191387' fundAmt: 472 batchReference: '28211229617' batchType: D customerBatchReference: '00000000003' customerName: PROSPAY INC merchantNumber: '08038133842' externalMid: '8038133842' storeNumber: '' chain: '00000' batchAmt: 489 amount: 9 surchgAmount: 0 convnceAmt: 0 cardType: '006' chargeType: '01602' chargeTypeDescription: V COMM CNP - BUS TIER 1 cardPlan: VISA cardNo: 424631******9986 chkNum: '' transactionDate: '2021-07-30T00:00:00.000Z' settlementDate: '2021-07-30T00:00:00.000Z' authorizationCode: 05013G chargebackControlNo: '' rocText: '' trnAci: W cardSchemeRef: '301211741000245' trnRefNum: '28211229625' settlementMethod: ACH currencyCode: USD cbAcqRefId: '' chgbkRsnCode: '' chgbkRsnDesc: '' merRef: '00730203500' purchId: '003073020450008' custCod: '003073020450008' trnArn: '24755421211282112296250' termId: '0005420000008038133842' entNum: '41854' createdAt: '2021-08-03T19:42:42.726Z' updatedAt: '2021-08-03T19:42:42.726Z' rate: 3.3816 perItem: 0 fee: 0.304344 offsetFee: 0.0009 baseAmount: 9 card: number: 424631******9986 network: visa exp: '1024' type: credit last4: '9986' vaultId: 60dc6d55017076001d27d4a0 name: Saday transactionAt: '2021-07-30T20:35:00.757Z' __v: 0 - _id: 610aea0aadf457001c6e4c70 processed: true isoName: Prospay Inc. notifiedDate: '2021-07-31T00:00:00.000Z' fileName: GIR1.PROSPAYZERO.XF00.017EN041854FUND20210731 paymentReference: '121100000334809' paymentDate: '2021-07-30T00:00:00.000Z' accountNumber: '*********8521' routingNumber: '00263191387' fundAmt: 472 batchReference: '28211229617' batchType: D customerBatchReference: '00000000003' customerName: PROSPAY INC merchantNumber: '08038133842' externalMid: '8038133842' storeNumber: '' chain: '00000' batchAmt: 489 amount: 104 surchgAmount: 0 convnceAmt: 0 cardType: '110' chargeType: '10039' chargeTypeDescription: AMEX B2B/WHOLESALE 1 CNP cardPlan: AEXP cardNo: 371557*****2030 chkNum: '' transactionDate: '2021-07-30T00:00:00.000Z' settlementDate: '2021-07-30T00:00:00.000Z' authorizationCode: '147348' chargebackControlNo: '' rocText: '' trnAci: A cardSchemeRef: '003015976428065' trnRefNum: '28211229626' settlementMethod: ACH currencyCode: USD cbAcqRefId: '' chgbkRsnCode: '' chgbkRsnDesc: '' merRef: '00730212412' purchId: '' custCod: '' trnArn: 0000000000028211229626X termId: '0005420000008038133842' entNum: '41854' createdAt: '2021-08-03T19:42:42.726Z' updatedAt: '2021-08-03T19:42:42.726Z' rate: 3.3816 perItem: 0 fee: 3.516864 offsetFee: 0.010400000000000001 baseAmount: 100 card: name: Demo Card number: 411111******1111 paymentToken: V5Te5m5D-hb5FZ4-mX2te8-7tfApNRx3pKr vaultId: 60d481560e64b7001ca3efdd type: credit last4: '2030' network: amex transactionAt: '2021-07-30T21:24:13.014Z' __v: 0 meta: count: 11 page: 1 '401': description: Unauthorized security: - bearer: [] summary: Get deposit details tags: - Reports /v1/public/subscription: get: description: >- Returns a paginated list of subscriptions. Filter by `customerId` to list subscriptions for a specific customer, or by `email` to find subscriptions by customer email address. operationId: listSubscriptions parameters: - name: page required: false in: query description: Page number for paginating schema: type: number - name: limit required: false in: query description: Limit items per page schema: type: number responses: '200': description: Paginated subscriptions. content: application/json: examples: example1: summary: List Subscription value: meta: count: 567 totalPages: 23 page: '1' limit: '25' data: - id: 67dd39b8e2b6d8bad2394b3e nextPayment: '2025-04-07T04:00:00.000Z' deletedAt: null plan: id: 67dd3993ede928b933592483 payments: 3 amount: 30 untilTerminated: false name: API Plan dayFrequency: 0 monthFrequency: 1 dayOfMonth: 7 amount: 30 surcharge: 0 startDate: '2025-03-22T04:00:00.000Z' autoRenew: true notificationMail: true status: running untilTerminated: false createdAt: '2025-03-21T10:04:40.927Z' updatedAt: '2025-03-21T10:04:40.965Z' customer: id: 653fc5c7ac4a672176bbb48c firstName: Rosayda lastName: Valiente Mesa companyName: '' paymentMethod: billingAddress: null last4: '0047' customerVaultId: '9415875278' type: credit zipCode: '12345' exp: '1128' name: Test Postman network: discover brand: discover number: 601197******0047 bin: '60119737' isSurchargeEligible: false isZipCodeEligible: false paymentMethods: - billingAddress: null last4: '0047' customerVaultId: '9415875278' type: credit zipCode: '12345' exp: '1128' name: Test Postman network: discover brand: discover number: 601197******0047 bin: '60119737' isSurchargeEligible: false isZipCodeEligible: false phoneNumber: '6474121454' email: rosita6505@gmail.com zipCode: '12345' billingAddress: company: '' country: US address: '' address2: '' city: '' state: '' shippingAddress: company: '' country: US address: '' address2: '' city: '' state: '' firstPayment: {} reference: STR-CYT-250321-07521 - id: 67dd19eeede928b933590ee4 nextPayment: '2025-04-07T04:00:00.000Z' deletedAt: null plan: id: 674bedcb60d64f0702ac4eb0 payments: 3 amount: 30 untilTerminated: false name: API Plan dayFrequency: 0 monthFrequency: 1 dayOfMonth: 7 amount: 30 surcharge: 1 startDate: '2025-03-22T04:00:00.000Z' autoRenew: false notificationMail: false status: running untilTerminated: false createdAt: '2025-03-21T07:49:02.423Z' updatedAt: '2025-03-21T07:49:17.969Z' customer: id: 67dd15afe2b6d8bad2392cd9 firstName: Pablo lastName: López companyName: Cypress e2e Testing paymentMethod: billingAddress: address: 74TH AVE address2: '' country: US city: Miami state: Alaska zipCode: '33122' last4: '0254' customerVaultId: '8358149057' type: credit zipCode: '12656' exp: '1229' name: John Doe network: visa brand: visa number: 476173******0254 bin: '47617320' isSurchargeEligible: true isZipCodeEligible: true paymentMethods: - billingAddress: address: 74TH AVE address2: '' country: US city: Miami state: Alaska zipCode: '33122' last4: '0254' customerVaultId: '8358149057' type: credit zipCode: '12656' exp: '1229' name: John Doe network: visa brand: visa number: 476173******0254 bin: '47617320' isSurchargeEligible: true isZipCodeEligible: true phoneNumber: '1337136745' email: rosypayxero@gmail.com zipCode: '12656' billingAddress: company: '' country: US address: 74TH AVE address2: '' city: Miami state: Alaska shippingAddress: company: '' country: US address: 74TH AVE address2: '' city: Miami state: Alaska firstPayment: {} reference: STR-CYT-250321-07519 order: customValues: - key: customer_code label: Customer Code value: Ramdom123 valueLabel: '' - key: Test1 label: Test1 value: Ramdom123 valueLabel: '' orderDescription: Test note tax: 0 - id: 67dd18d7ede928b933590e32 nextPayment: '2025-03-22T04:00:00.000Z' deletedAt: null plan: payments: 0 amount: 120 untilTerminated: true name: Custom dayFrequency: 20 monthFrequency: 0 dayOfMonth: 0 amount: 120 surcharge: 4 startDate: '2025-03-22T04:00:00.000Z' autoRenew: false notificationMail: false status: running untilTerminated: true createdAt: '2025-03-21T07:44:23.586Z' updatedAt: '2025-03-21T07:44:23.621Z' customer: id: 67dd18b5e2b6d8bad2392de3 firstName: Pablo lastName: López companyName: Cypress e2e Testing paymentMethod: billingAddress: address: 74TH AVE address2: '' country: US city: Miami state: Alaska zipCode: '33122' last4: '1202' customerVaultId: '8934099777' type: credit zipCode: '12656' exp: '1229' name: John Doe network: visa brand: visa number: 400551******1202 bin: '40055144' isSurchargeEligible: true isZipCodeEligible: true paymentMethods: - billingAddress: address: 74TH AVE address2: '' country: US city: Miami state: Alaska zipCode: '33122' last4: '1202' customerVaultId: '8934099777' type: credit zipCode: '12656' exp: '1229' name: John Doe network: visa brand: visa number: 400551******1202 bin: '40055144' isSurchargeEligible: true isZipCodeEligible: true phoneNumber: '1337136745' email: rosypayxero@gmail.com zipCode: '12656' billingAddress: company: '' country: US address: 74TH AVE address2: '' city: Miami state: Alaska shippingAddress: company: '' country: US address: 74TH AVE address2: '' city: Miami state: Alaska firstPayment: {} reference: STR-CYT-250321-07516 order: customValues: - key: customer_code label: Customer Code value: Ramdom123 valueLabel: '' - key: Test1 label: Test1 value: Ramdom123 valueLabel: '' orderDescription: Test note tax: 0 - id: 67dd18c9e2b6d8bad2392dfc nextPayment: '2025-03-22T04:00:00.000Z' deletedAt: null plan: id: 67dd1726e2b6d8bad2392dc4 payments: 10 amount: 50 untilTerminated: false name: Plan Test dayFrequency: 3 monthFrequency: 0 dayOfMonth: 0 amount: 50 surcharge: 2 startDate: '2025-03-22T04:00:00.000Z' autoRenew: false notificationMail: false status: running untilTerminated: false createdAt: '2025-03-21T07:44:09.424Z' updatedAt: '2025-03-21T07:44:14.023Z' customer: id: 67dd18b5e2b6d8bad2392de3 firstName: Pablo lastName: López companyName: Cypress e2e Testing paymentMethod: billingAddress: address: 74TH AVE address2: '' country: US city: Miami state: Alaska zipCode: '33122' last4: '1202' customerVaultId: '8934099777' type: credit zipCode: '12656' exp: '1229' name: John Doe network: visa brand: visa number: 400551******1202 bin: '40055144' isSurchargeEligible: true isZipCodeEligible: true paymentMethods: - billingAddress: address: 74TH AVE address2: '' country: US city: Miami state: Alaska zipCode: '33122' last4: '1202' customerVaultId: '8934099777' type: credit zipCode: '12656' exp: '1229' name: John Doe network: visa brand: visa number: 400551******1202 bin: '40055144' isSurchargeEligible: true isZipCodeEligible: true phoneNumber: '1337136745' email: rosypayxero@gmail.com zipCode: '12656' billingAddress: company: '' country: US address: 74TH AVE address2: '' city: Miami state: Alaska shippingAddress: company: '' country: US address: 74TH AVE address2: '' city: Miami state: Alaska firstPayment: paymentId: 67dd18cde2b6d8bad2392e0f amount: 125 surcharge: 4 updatedAt: '2025-03-21T07:44:14.023Z' createdAt: '2025-03-21T07:44:14.023Z' reference: STR-CYT-250321-07515 order: customValues: - key: customer_code label: Customer Code value: Ramdom123 valueLabel: '' - key: Test1 label: Test1 value: Ramdom123 valueLabel: '' orderDescription: Test note tax: 0 - id: 67dd18bfede928b933590e14 nextPayment: '2025-04-07T04:00:00.000Z' deletedAt: null plan: id: 674bedcb60d64f0702ac4eb0 payments: 3 amount: 30 untilTerminated: false name: API Plan dayFrequency: 0 monthFrequency: 1 dayOfMonth: 7 amount: 30 surcharge: 1 startDate: '2025-03-22T04:00:00.000Z' autoRenew: false notificationMail: false status: running untilTerminated: false createdAt: '2025-03-21T07:43:59.043Z' updatedAt: '2025-03-21T07:43:59.261Z' customer: id: 67dd18b5e2b6d8bad2392de3 firstName: Pablo lastName: López companyName: Cypress e2e Testing paymentMethod: billingAddress: address: 74TH AVE address2: '' country: US city: Miami state: Alaska zipCode: '33122' last4: '1202' customerVaultId: '8934099777' type: credit zipCode: '12656' exp: '1229' name: John Doe network: visa brand: visa number: 400551******1202 bin: '40055144' isSurchargeEligible: true isZipCodeEligible: true paymentMethods: - billingAddress: address: 74TH AVE address2: '' country: US city: Miami state: Alaska zipCode: '33122' last4: '1202' customerVaultId: '8934099777' type: credit zipCode: '12656' exp: '1229' name: John Doe network: visa brand: visa number: 400551******1202 bin: '40055144' isSurchargeEligible: true isZipCodeEligible: true phoneNumber: '1337136745' email: rosypayxero@gmail.com zipCode: '12656' billingAddress: company: '' country: US address: 74TH AVE address2: '' city: Miami state: Alaska shippingAddress: company: '' country: US address: 74TH AVE address2: '' city: Miami state: Alaska firstPayment: {} reference: STR-CYT-250321-07514 order: customValues: - key: customer_code label: Customer Code value: Ramdom123 valueLabel: '' - key: Test1 label: Test1 value: Ramdom123 valueLabel: '' orderDescription: Test note tax: 0 - id: 67d7d2198e60167fcf150cc7 nextPayment: '2025-03-24T04:00:00.000Z' deletedAt: null plan: id: 65a71c40ec0ccce66a6b5c70 payments: 10 amount: 50 untilTerminated: false name: New Plan Test Unico dayFrequency: 3 monthFrequency: 0 dayOfMonth: 0 amount: 50 surcharge: 2 startDate: '2025-03-18T04:00:00.000Z' autoRenew: false notificationMail: false status: running untilTerminated: false createdAt: '2025-03-17T07:41:13.553Z' updatedAt: '2025-03-21T07:15:21.039Z' customer: id: 67d7d2108e60167fcf150cba firstName: Pablo lastName: López companyName: Cypress e2e Testing paymentMethod: billingAddress: address: 74TH AVE address2: '' country: US city: Miami state: Alaska zipCode: '33122' last4: '1202' customerVaultId: '4885139712' type: credit zipCode: '12656' exp: '1229' name: John Doe network: visa brand: visa number: 400551******1202 bin: '40055144' isSurchargeEligible: true isZipCodeEligible: true paymentMethods: - billingAddress: address: 74TH AVE address2: '' country: US city: Miami state: Alaska zipCode: '33122' last4: '1202' customerVaultId: '4885139712' type: credit zipCode: '12656' exp: '1229' name: John Doe network: visa brand: visa number: 400551******1202 bin: '40055144' isSurchargeEligible: true isZipCodeEligible: true phoneNumber: '1337136745' email: rosypayxero@gmail.com zipCode: '12656' billingAddress: company: '' country: US address: 74TH AVE address2: '' city: Miami state: Alaska shippingAddress: company: '' country: US address: 74TH AVE address2: '' city: Miami state: Alaska firstPayment: {} reference: STR-CYT-250317-07458 order: customValues: - key: customer_code label: Customer Code value: Ramdom123 valueLabel: '' - key: Test1 label: Test1 value: Ramdom123 valueLabel: '' orderDescription: Test note tax: 0 - id: 67cbf2fe057155254b5ddb06 nextPayment: '2025-03-24T04:00:00.000Z' deletedAt: null plan: id: 65a71c40ec0ccce66a6b5c70 payments: 10 amount: 50 untilTerminated: false name: New Plan Test Unico dayFrequency: 3 monthFrequency: 0 dayOfMonth: 0 amount: 50 surcharge: 2 startDate: '2025-03-09T05:00:00.000Z' autoRenew: false notificationMail: false status: running untilTerminated: false createdAt: '2025-03-08T07:34:22.128Z' updatedAt: '2025-03-21T07:15:20.012Z' customer: id: 67cbf2ea057155254b5ddadf firstName: Pablo lastName: López companyName: Cypress e2e Testing paymentMethod: billingAddress: address: 74TH AVE address2: '' country: US city: Miami state: Alaska zipCode: '33122' last4: '1202' customerVaultId: '3857825178' type: credit zipCode: '12656' exp: '1229' name: John Doe network: visa brand: visa number: 400551******1202 bin: '40055144' isSurchargeEligible: true isZipCodeEligible: true paymentMethods: - billingAddress: address: 74TH AVE address2: '' country: US city: Miami state: Alaska zipCode: '33122' last4: '1202' customerVaultId: '3857825178' type: credit zipCode: '12656' exp: '1229' name: John Doe network: visa brand: visa number: 400551******1202 bin: '40055144' isSurchargeEligible: true isZipCodeEligible: true phoneNumber: '1337136745' email: rosypayxero@gmail.com zipCode: '12656' billingAddress: company: '' country: US address: 74TH AVE address2: '' city: Miami state: Alaska shippingAddress: company: '' country: US address: 74TH AVE address2: '' city: Miami state: Alaska firstPayment: paymentId: 67cbf2ff057155254b5ddb19 amount: 149 surcharge: 4 updatedAt: '2025-03-08T07:34:34.610Z' createdAt: '2025-03-08T07:34:34.610Z' reference: STR-CYT-250308-07334 order: customValues: - key: customer_code label: Customer Code value: Ramdom123 valueLabel: '' - key: Test1 label: Test1 value: Ramdom123 valueLabel: '' orderDescription: Test note tax: 0 - id: 67cfe85e17431205fcce64de nextPayment: '2025-03-24T04:00:00.000Z' deletedAt: null plan: id: 65a71c40ec0ccce66a6b5c70 payments: 10 amount: 50 untilTerminated: false name: New Plan Test Unico dayFrequency: 3 monthFrequency: 0 dayOfMonth: 0 amount: 50 surcharge: 2 startDate: '2025-03-12T04:00:00.000Z' autoRenew: false notificationMail: false status: running untilTerminated: false createdAt: '2025-03-11T07:38:06.566Z' updatedAt: '2025-03-21T07:15:19.507Z' customer: id: 67cfe8543a6650eb85b58404 firstName: Pablo lastName: López companyName: Cypress e2e Testing paymentMethod: billingAddress: address: 74TH AVE address2: '' country: US city: Miami state: Alaska zipCode: '33122' last4: '1202' customerVaultId: '8797747634' type: credit zipCode: '12656' exp: '1229' name: John Doe network: visa brand: visa number: 400551******1202 bin: '40055144' isSurchargeEligible: true isZipCodeEligible: true paymentMethods: - billingAddress: address: 74TH AVE address2: '' country: US city: Miami state: Alaska zipCode: '33122' last4: '1202' customerVaultId: '8797747634' type: credit zipCode: '12656' exp: '1229' name: John Doe network: visa brand: visa number: 400551******1202 bin: '40055144' isSurchargeEligible: true isZipCodeEligible: true phoneNumber: '1337136745' email: rosypayxero@gmail.com zipCode: '12656' billingAddress: company: '' country: US address: 74TH AVE address2: '' city: Miami state: Alaska shippingAddress: company: '' country: US address: 74TH AVE address2: '' city: Miami state: Alaska firstPayment: {} reference: STR-CYT-250311-07373 order: customValues: - key: customer_code label: Customer Code value: Ramdom123 valueLabel: '' - key: Test1 label: Test1 value: Ramdom123 valueLabel: '' orderDescription: Test note tax: 0 - id: 67c165a19acba8f780537a56 nextPayment: '2025-04-10T04:00:00.000Z' deletedAt: null plan: payments: 0 amount: 143 untilTerminated: true name: Custom dayFrequency: 20 monthFrequency: 0 dayOfMonth: 0 amount: 143 surcharge: 4 startDate: '2025-03-01T05:00:00.000Z' autoRenew: false notificationMail: false status: running untilTerminated: true createdAt: '2025-02-28T07:28:33.280Z' updatedAt: '2025-03-21T07:15:18.471Z' customer: id: 67c16584e9582e2e5d203c03 firstName: Pablo lastName: López companyName: Cypress e2e Testing paymentMethod: billingAddress: address: 74TH AVE address2: '' country: US city: Miami state: Alaska zipCode: '33122' last4: '1202' customerVaultId: '4839219402' type: credit zipCode: '12656' exp: '1229' name: John Doe network: visa brand: visa number: 400551******1202 bin: '40055144' isSurchargeEligible: true isZipCodeEligible: true paymentMethods: - billingAddress: address: 74TH AVE address2: '' country: US city: Miami state: Alaska zipCode: '33122' last4: '1202' customerVaultId: '4839219402' type: credit zipCode: '12656' exp: '1229' name: John Doe network: visa brand: visa number: 400551******1202 bin: '40055144' isSurchargeEligible: true isZipCodeEligible: true phoneNumber: '1337136745' email: rosypayxero@gmail.com zipCode: '12656' billingAddress: company: '' country: US address: 74TH AVE address2: '' city: Miami state: Alaska shippingAddress: company: '' country: US address: 74TH AVE address2: '' city: Miami state: Alaska firstPayment: {} reference: STR-CYT-250228-07223 order: customValues: - key: customer_code label: Customer Code value: Ramdom123 valueLabel: '' - key: Test1 label: Test1 value: Ramdom123 valueLabel: '' orderDescription: Test note tax: 0 - id: 67c0158d5b4d441748307153 nextPayment: '2025-03-24T04:00:00.000Z' deletedAt: null plan: id: 65a71c40ec0ccce66a6b5c70 payments: 10 amount: 50 untilTerminated: false name: New Plan Test Unico dayFrequency: 3 monthFrequency: 0 dayOfMonth: 0 amount: 50 surcharge: 2 startDate: '2025-02-28T05:00:00.000Z' autoRenew: false notificationMail: false status: running untilTerminated: false createdAt: '2025-02-27T07:34:37.306Z' updatedAt: '2025-03-21T07:15:18.105Z' customer: id: 67c0157abd5c46f76dc1f929 firstName: Pablo lastName: López companyName: Cypress e2e Testing paymentMethod: billingAddress: address: 74TH AVE address2: '' country: US city: Miami state: Alaska zipCode: '33122' last4: '1202' customerVaultId: '4309221828' type: credit zipCode: '12656' exp: '1229' name: John Doe network: visa brand: visa number: 400551******1202 bin: '40055144' isSurchargeEligible: true isZipCodeEligible: true paymentMethods: - billingAddress: address: 74TH AVE address2: '' country: US city: Miami state: Alaska zipCode: '33122' last4: '1202' customerVaultId: '4309221828' type: credit zipCode: '12656' exp: '1229' name: John Doe network: visa brand: visa number: 400551******1202 bin: '40055144' isSurchargeEligible: true isZipCodeEligible: true phoneNumber: '1337136745' email: rosypayxero@gmail.com zipCode: '12656' billingAddress: company: '' country: US address: 74TH AVE address2: '' city: Miami state: Alaska shippingAddress: company: '' country: US address: 74TH AVE address2: '' city: Miami state: Alaska firstPayment: paymentId: 67c0158f5b4d441748307166 amount: 158 surcharge: 5 updatedAt: '2025-02-27T07:34:40.114Z' createdAt: '2025-02-27T07:34:40.114Z' reference: STR-CYT-250227-07203 order: customValues: - key: customer_code label: Customer Code value: Ramdom123 valueLabel: '' orderDescription: Test note tax: 0 - id: 67c7fee5ae2a9dbd7dc1def7 nextPayment: '2025-03-24T04:00:00.000Z' deletedAt: null plan: id: 65a71c40ec0ccce66a6b5c70 payments: 10 amount: 50 untilTerminated: false name: New Plan Test Unico dayFrequency: 3 monthFrequency: 0 dayOfMonth: 0 amount: 50 surcharge: 2 startDate: '2025-03-06T05:00:00.000Z' autoRenew: false notificationMail: false status: running untilTerminated: false createdAt: '2025-03-05T07:36:05.700Z' updatedAt: '2025-03-21T07:15:16.795Z' customer: id: 67c7fb25ae2a9dbd7dc1db3f firstName: Pablo lastName: López companyName: Cypress e2e Testing paymentMethod: billingAddress: address: 74TH AVE address2: '' country: US city: Miami state: Alaska zipCode: '33122' last4: '0254' customerVaultId: '0180518071' type: credit zipCode: '12656' exp: '1229' name: John Doe network: visa brand: visa number: 476173******0254 bin: '47617320' isSurchargeEligible: true isZipCodeEligible: true paymentMethods: - billingAddress: address: 74TH AVE address2: '' country: US city: Miami state: Alaska zipCode: '33122' last4: '0254' customerVaultId: '0180518071' type: credit zipCode: '12656' exp: '1229' name: John Doe network: visa brand: visa number: 476173******0254 bin: '47617320' isSurchargeEligible: true isZipCodeEligible: true phoneNumber: '1337136745' email: rosypayxero@gmail.com zipCode: '12656' billingAddress: company: '' country: US address: 74TH AVE address2: '' city: Miami state: Alaska shippingAddress: company: '' country: US address: 74TH AVE address2: '' city: Miami state: Alaska firstPayment: {} reference: STR-CYT-250305-07297 order: customValues: - key: customer_code label: Customer Code value: Ramdom123 valueLabel: '' - key: Test1 label: Test1 value: Ramdom123 valueLabel: '' orderDescription: Test note tax: 0 - id: 67bc210463e3280caaa69ed0 nextPayment: '2025-03-24T04:00:00.000Z' deletedAt: null plan: id: 65a71c40ec0ccce66a6b5c70 payments: 10 amount: 50 untilTerminated: false name: New Plan Test Unico dayFrequency: 3 monthFrequency: 0 dayOfMonth: 0 amount: 50 surcharge: 2 startDate: '2025-02-25T05:00:00.000Z' autoRenew: false notificationMail: false status: running untilTerminated: false createdAt: '2025-02-24T07:34:28.264Z' updatedAt: '2025-03-21T07:15:16.057Z' customer: id: 67bc20fb63e3280caaa69ebb firstName: Pablo lastName: López companyName: Cypress e2e Testing paymentMethod: billingAddress: address: 74TH AVE address2: '' country: US city: Miami state: Alaska zipCode: '33122' last4: '1202' customerVaultId: '5044819706' type: credit zipCode: '12656' exp: '1229' name: John Doe network: visa brand: visa number: 400551******1202 bin: '40055144' isSurchargeEligible: true isZipCodeEligible: true paymentMethods: - billingAddress: address: 74TH AVE address2: '' country: US city: Miami state: Alaska zipCode: '33122' last4: '1202' customerVaultId: '5044819706' type: credit zipCode: '12656' exp: '1229' name: John Doe network: visa brand: visa number: 400551******1202 bin: '40055144' isSurchargeEligible: true isZipCodeEligible: true phoneNumber: '1337136745' email: rosypayxero@gmail.com zipCode: '12656' billingAddress: company: '' country: US address: 74TH AVE address2: '' city: Miami state: Alaska shippingAddress: company: '' country: US address: 74TH AVE address2: '' city: Miami state: Alaska firstPayment: {} reference: STR-CYT-250224-07156 order: customValues: - key: customer_code label: Customer Code value: Ramdom123 valueLabel: '' orderDescription: Test note tax: 0 - id: 67c0cd895b4d44174830c596 nextPayment: '2025-03-24T04:00:00.000Z' deletedAt: null plan: id: 65a71c40ec0ccce66a6b5c70 payments: 10 amount: 50 untilTerminated: false name: New Plan Test Unico dayFrequency: 3 monthFrequency: 0 dayOfMonth: 0 amount: 50 surcharge: 2 startDate: '2025-02-28T05:00:00.000Z' autoRenew: false notificationMail: false status: running untilTerminated: false createdAt: '2025-02-27T20:39:37.634Z' updatedAt: '2025-03-21T07:15:15.935Z' customer: id: 67c0c35da0ad71526017cd3c firstName: Pablo lastName: López companyName: Cypress e2e Testing paymentMethod: billingAddress: address: 74TH AVE address2: '' country: US city: Miami state: Alaska zipCode: '33122' last4: '1202' customerVaultId: '4874518038' type: credit zipCode: '12656' exp: '1229' name: John Doe network: visa brand: visa number: 400551******1202 bin: '40055144' isSurchargeEligible: true isZipCodeEligible: true paymentMethods: - billingAddress: address: 74TH AVE address2: '' country: US city: Miami state: Alaska zipCode: '33122' last4: '1202' customerVaultId: '4874518038' type: credit zipCode: '12656' exp: '1229' name: John Doe network: visa brand: visa number: 400551******1202 bin: '40055144' isSurchargeEligible: true isZipCodeEligible: true phoneNumber: '1337136745' email: rosypayxero@gmail.com zipCode: '12656' billingAddress: company: '' country: US address: 74TH AVE address2: '' city: Miami state: Alaska shippingAddress: company: '' country: US address: 74TH AVE address2: '' city: Miami state: Alaska firstPayment: {} reference: STR-CYT-250227-07214 order: customValues: - key: customer_code label: Customer Code value: Ramdom123 valueLabel: '' - key: Test1 label: Test1 value: Ramdom123 valueLabel: '' orderDescription: Test note tax: 0 - id: 676a95264ea7cae4b646d5fa nextPayment: '2025-04-05T04:00:00.000Z' deletedAt: null plan: id: 65494245374c233607906c59 payments: 0 amount: 200 untilTerminated: true name: test subs dayFrequency: 15 monthFrequency: 0 dayOfMonth: 0 amount: 200 surcharge: 0 startDate: '2025-01-20T05:00:00.000Z' autoRenew: true notificationMail: true status: running untilTerminated: true createdAt: '2024-12-24T11:04:06.245Z' updatedAt: '2025-03-21T07:15:15.564Z' customer: id: 653fc5c7ac4a672176bbb48c firstName: Rosayda lastName: Valiente Mesa companyName: '' paymentMethod: billingAddress: null last4: '0047' customerVaultId: '9415875278' type: credit zipCode: '12345' exp: '1128' name: Test Postman network: discover brand: discover number: 601197******0047 bin: '60119737' isSurchargeEligible: false isZipCodeEligible: false paymentMethods: - billingAddress: null last4: '0047' customerVaultId: '9415875278' type: credit zipCode: '12345' exp: '1128' name: Test Postman network: discover brand: discover number: 601197******0047 bin: '60119737' isSurchargeEligible: false isZipCodeEligible: false phoneNumber: '6474121454' email: rosita6505@gmail.com zipCode: '12345' billingAddress: company: '' country: US address: '' address2: '' city: '' state: '' shippingAddress: company: '' country: US address: '' address2: '' city: '' state: '' firstPayment: {} reference: STR-CYT-241224-05808 order: customValues: - key: customer_code label: Customer Code value: '2523' valueLabel: '' tax: 0 - id: 67a705b04aebe8ebdacf4777 nextPayment: '2025-04-10T04:00:00.000Z' deletedAt: null plan: payments: 0 amount: 184 untilTerminated: true name: Custom dayFrequency: 20 monthFrequency: 0 dayOfMonth: 0 amount: 184 surcharge: 6 startDate: '2025-02-09T05:00:00.000Z' autoRenew: false notificationMail: false status: running untilTerminated: true createdAt: '2025-02-08T07:20:16.092Z' updatedAt: '2025-03-21T07:15:15.433Z' customer: id: 67a705944aebe8ebdacf46fa firstName: Pablo lastName: López companyName: Cypress e2e Testing paymentMethod: billingAddress: address: 74TH AVE address2: '' country: US city: Miami state: Alaska zipCode: '33122' last4: '1202' customerVaultId: '3569127811' type: credit zipCode: '12656' exp: '1229' name: John Doe network: visa brand: visa number: 400551******1202 bin: '40055144' isSurchargeEligible: true isZipCodeEligible: true paymentMethods: - billingAddress: address: 74TH AVE address2: '' country: US city: Miami state: Alaska zipCode: '33122' last4: '1202' customerVaultId: '3569127811' type: credit zipCode: '12656' exp: '1229' name: John Doe network: visa brand: visa number: 400551******1202 bin: '40055144' isSurchargeEligible: true isZipCodeEligible: true phoneNumber: '1337136745' email: rosypayxero@gmail.com zipCode: '12656' billingAddress: company: '' country: US address: 74TH AVE address2: '' city: Miami state: Alaska shippingAddress: company: '' country: US address: 74TH AVE address2: '' city: Miami state: Alaska firstPayment: {} reference: STR-CYT-250208-06885 order: customValues: - key: customer_code label: Customer Code value: Ramdom123 valueLabel: '' orderDescription: Test note tax: 0 - id: 67c40b03a07cd6d02f1357d4 nextPayment: '2025-03-24T04:00:00.000Z' deletedAt: null plan: id: 65a71c40ec0ccce66a6b5c70 payments: 10 amount: 50 untilTerminated: false name: New Plan Test Unico dayFrequency: 3 monthFrequency: 0 dayOfMonth: 0 amount: 50 surcharge: 2 startDate: '2025-03-03T05:00:00.000Z' autoRenew: false notificationMail: false status: running untilTerminated: false createdAt: '2025-03-02T07:38:43.635Z' updatedAt: '2025-03-21T07:15:13.791Z' customer: id: 67c40af1a07cd6d02f1357bb firstName: Pablo lastName: López companyName: Cypress e2e Testing paymentMethod: billingAddress: address: 74TH AVE address2: '' country: US city: Miami state: Alaska zipCode: '33122' last4: '1202' customerVaultId: '8739404837' type: credit zipCode: '12656' exp: '1229' name: John Doe network: visa brand: visa number: 400551******1202 bin: '40055144' isSurchargeEligible: true isZipCodeEligible: true paymentMethods: - billingAddress: address: 74TH AVE address2: '' country: US city: Miami state: Alaska zipCode: '33122' last4: '1202' customerVaultId: '8739404837' type: credit zipCode: '12656' exp: '1229' name: John Doe network: visa brand: visa number: 400551******1202 bin: '40055144' isSurchargeEligible: true isZipCodeEligible: true phoneNumber: '1337136745' email: rosypayxero@gmail.com zipCode: '12656' billingAddress: company: '' country: US address: 74TH AVE address2: '' city: Miami state: Alaska shippingAddress: company: '' country: US address: 74TH AVE address2: '' city: Miami state: Alaska firstPayment: paymentId: 67c40b06a07cd6d02f1357e7 amount: 157 surcharge: 5 updatedAt: '2025-03-02T07:38:47.470Z' createdAt: '2025-03-02T07:38:47.470Z' reference: STR-CYT-250302-07250 order: customValues: - key: customer_code label: Customer Code value: Ramdom123 valueLabel: '' - key: Test1 label: Test1 value: Ramdom123 valueLabel: '' orderDescription: Test note tax: 0 - id: 67b82d2a8ebad440fe3e21c4 nextPayment: null deletedAt: null plan: id: 65a71c40ec0ccce66a6b5c70 payments: 10 amount: 50 untilTerminated: false name: New Plan Test Unico dayFrequency: 3 monthFrequency: 0 dayOfMonth: 0 amount: 50 surcharge: 2 startDate: '2025-02-22T05:00:00.000Z' autoRenew: false notificationMail: false status: completed untilTerminated: false createdAt: '2025-02-21T07:37:14.841Z' updatedAt: '2025-03-21T07:15:13.562Z' customer: id: 67b82d198ebad440fe3e219f firstName: Pablo lastName: López companyName: Cypress e2e Testing paymentMethod: billingAddress: address: 74TH AVE address2: '' country: US city: Miami state: Alaska zipCode: '33122' last4: '1202' customerVaultId: '9218244139' type: credit zipCode: '12656' exp: '1229' name: John Doe network: visa brand: visa number: 400551******1202 bin: '40055144' isSurchargeEligible: true isZipCodeEligible: true paymentMethods: - billingAddress: address: 74TH AVE address2: '' country: US city: Miami state: Alaska zipCode: '33122' last4: '1202' customerVaultId: '9218244139' type: credit zipCode: '12656' exp: '1229' name: John Doe network: visa brand: visa number: 400551******1202 bin: '40055144' isSurchargeEligible: true isZipCodeEligible: true phoneNumber: '1337136745' email: rosypayxero@gmail.com zipCode: '12656' billingAddress: company: '' country: US address: 74TH AVE address2: '' city: Miami state: Alaska shippingAddress: company: '' country: US address: 74TH AVE address2: '' city: Miami state: Alaska firstPayment: paymentId: 67b82d2e8ebad440fe3e21d7 amount: 181 surcharge: 5 updatedAt: '2025-02-21T07:37:18.723Z' createdAt: '2025-02-21T07:37:18.723Z' reference: STR-CYT-250221-07113 order: customValues: - key: customer_code label: Customer Code value: Ramdom123 valueLabel: '' orderDescription: Test note tax: 0 - id: 67dbc678e2b6d8bad238a5a4 nextPayment: '2025-03-24T04:00:00.000Z' deletedAt: null plan: id: 65a71c40ec0ccce66a6b5c70 payments: 10 amount: 50 untilTerminated: false name: New Plan Test Unico dayFrequency: 3 monthFrequency: 0 dayOfMonth: 0 amount: 50 surcharge: 2 startDate: '2025-03-21T04:00:00.000Z' autoRenew: false notificationMail: false status: running untilTerminated: false createdAt: '2025-03-20T07:40:40.623Z' updatedAt: '2025-03-21T07:15:12.826Z' customer: id: 67dbc663e2b6d8bad238a589 firstName: Pablo lastName: López companyName: Cypress e2e Testing paymentMethod: billingAddress: address: 74TH AVE address2: '' country: US city: Miami state: Alaska zipCode: '33122' last4: '1202' customerVaultId: '4655219304' type: credit zipCode: '12656' exp: '1229' name: John Doe network: visa brand: visa number: 400551******1202 bin: '40055144' isSurchargeEligible: true isZipCodeEligible: true paymentMethods: - billingAddress: address: 74TH AVE address2: '' country: US city: Miami state: Alaska zipCode: '33122' last4: '1202' customerVaultId: '4655219304' type: credit zipCode: '12656' exp: '1229' name: John Doe network: visa brand: visa number: 400551******1202 bin: '40055144' isSurchargeEligible: true isZipCodeEligible: true phoneNumber: '1337136745' email: rosypayxero@gmail.com zipCode: '12656' billingAddress: company: '' country: US address: 74TH AVE address2: '' city: Miami state: Alaska shippingAddress: company: '' country: US address: 74TH AVE address2: '' city: Miami state: Alaska firstPayment: paymentId: 67dbc679e2b6d8bad238a5b7 amount: 171 surcharge: 5 updatedAt: '2025-03-20T07:40:42.164Z' createdAt: '2025-03-20T07:40:42.164Z' reference: STR-CYT-250320-07501 order: customValues: - key: customer_code label: Customer Code value: Ramdom123 valueLabel: '' - key: Test1 label: Test1 value: Ramdom123 valueLabel: '' orderDescription: Test note tax: 0 - id: 67dbc684ede928b933584840 nextPayment: '2025-04-10T04:00:00.000Z' deletedAt: null plan: payments: 0 amount: 189 untilTerminated: true name: Custom dayFrequency: 20 monthFrequency: 0 dayOfMonth: 0 amount: 189 surcharge: 6 startDate: '2025-03-21T04:00:00.000Z' autoRenew: false notificationMail: false status: running untilTerminated: true createdAt: '2025-03-20T07:40:52.035Z' updatedAt: '2025-03-21T07:15:12.726Z' customer: id: 67dbc663e2b6d8bad238a589 firstName: Pablo lastName: López companyName: Cypress e2e Testing paymentMethod: billingAddress: address: 74TH AVE address2: '' country: US city: Miami state: Alaska zipCode: '33122' last4: '1202' customerVaultId: '4655219304' type: credit zipCode: '12656' exp: '1229' name: John Doe network: visa brand: visa number: 400551******1202 bin: '40055144' isSurchargeEligible: true isZipCodeEligible: true paymentMethods: - billingAddress: address: 74TH AVE address2: '' country: US city: Miami state: Alaska zipCode: '33122' last4: '1202' customerVaultId: '4655219304' type: credit zipCode: '12656' exp: '1229' name: John Doe network: visa brand: visa number: 400551******1202 bin: '40055144' isSurchargeEligible: true isZipCodeEligible: true phoneNumber: '1337136745' email: rosypayxero@gmail.com zipCode: '12656' billingAddress: company: '' country: US address: 74TH AVE address2: '' city: Miami state: Alaska shippingAddress: company: '' country: US address: 74TH AVE address2: '' city: Miami state: Alaska firstPayment: {} reference: STR-CYT-250320-07502 order: customValues: - key: customer_code label: Customer Code value: Ramdom123 valueLabel: '' - key: Test1 label: Test1 value: Ramdom123 valueLabel: '' orderDescription: Test note tax: 0 - id: 67c7fdbbc64809ef4c2597e8 nextPayment: '2025-03-24T04:00:00.000Z' deletedAt: null plan: id: 65a71c40ec0ccce66a6b5c70 payments: 10 amount: 50 untilTerminated: false name: New Plan Test Unico dayFrequency: 3 monthFrequency: 0 dayOfMonth: 0 amount: 50 surcharge: 2 startDate: '2025-03-06T05:00:00.000Z' autoRenew: false notificationMail: false status: running untilTerminated: false createdAt: '2025-03-05T07:31:07.058Z' updatedAt: '2025-03-21T07:15:12.497Z' customer: id: 67c7fdb1c64809ef4c2597db firstName: Pablo lastName: López companyName: Cypress e2e Testing paymentMethod: billingAddress: address: 74TH AVE address2: '' country: US city: Miami state: Alaska zipCode: '33122' last4: '1202' customerVaultId: '8342097207' type: credit zipCode: '12656' exp: '1229' name: John Doe network: visa brand: visa number: 400551******1202 bin: '40055144' isSurchargeEligible: true isZipCodeEligible: true paymentMethods: - billingAddress: address: 74TH AVE address2: '' country: US city: Miami state: Alaska zipCode: '33122' last4: '1202' customerVaultId: '8342097207' type: credit zipCode: '12656' exp: '1229' name: John Doe network: visa brand: visa number: 400551******1202 bin: '40055144' isSurchargeEligible: true isZipCodeEligible: true phoneNumber: '1337136745' email: rosypayxero@gmail.com zipCode: '12656' billingAddress: company: '' country: US address: 74TH AVE address2: '' city: Miami state: Alaska shippingAddress: company: '' country: US address: 74TH AVE address2: '' city: Miami state: Alaska firstPayment: {} reference: STR-CYT-250305-07292 order: customValues: - key: customer_code label: Customer Code value: Ramdom123 valueLabel: '' - key: Test1 label: Test1 value: Ramdom123 valueLabel: '' orderDescription: Test note tax: 0 - id: 67d7d34d8e60167fcf150d81 nextPayment: '2025-03-24T04:00:00.000Z' deletedAt: null plan: id: 65a71c40ec0ccce66a6b5c70 payments: 10 amount: 50 untilTerminated: false name: New Plan Test Unico dayFrequency: 3 monthFrequency: 0 dayOfMonth: 0 amount: 50 surcharge: 2 startDate: '2025-03-18T04:00:00.000Z' autoRenew: false notificationMail: false status: running untilTerminated: false createdAt: '2025-03-17T07:46:21.018Z' updatedAt: '2025-03-21T07:15:11.129Z' customer: id: 67d7cf8afffe272a44a127d9 firstName: Pablo lastName: López companyName: Cypress e2e Testing paymentMethod: billingAddress: address: 74TH AVE address2: '' country: US city: Miami state: Alaska zipCode: '33122' last4: '0254' customerVaultId: '0162238691' type: credit zipCode: '12656' exp: '1229' name: John Doe network: visa brand: visa number: 476173******0254 bin: '47617320' isSurchargeEligible: true isZipCodeEligible: true paymentMethods: - billingAddress: address: 74TH AVE address2: '' country: US city: Miami state: Alaska zipCode: '33122' last4: '0254' customerVaultId: '0162238691' type: credit zipCode: '12656' exp: '1229' name: John Doe network: visa brand: visa number: 476173******0254 bin: '47617320' isSurchargeEligible: true isZipCodeEligible: true phoneNumber: '1337136745' email: rosypayxero@gmail.com zipCode: '12656' billingAddress: company: '' country: US address: 74TH AVE address2: '' city: Miami state: Alaska shippingAddress: company: '' country: US address: 74TH AVE address2: '' city: Miami state: Alaska firstPayment: {} reference: STR-CYT-250317-07463 order: customValues: - key: customer_code label: Customer Code value: Ramdom123 valueLabel: '' - key: Test1 label: Test1 value: Ramdom123 valueLabel: '' orderDescription: Test note tax: 0 - id: 67cfe9d0a2610d6006400ae0 nextPayment: '2025-03-24T04:00:00.000Z' deletedAt: null plan: id: 65a71c40ec0ccce66a6b5c70 payments: 10 amount: 50 untilTerminated: false name: New Plan Test Unico dayFrequency: 3 monthFrequency: 0 dayOfMonth: 0 amount: 50 surcharge: 2 startDate: '2025-03-12T04:00:00.000Z' autoRenew: false notificationMail: false status: running untilTerminated: false createdAt: '2025-03-11T07:44:16.784Z' updatedAt: '2025-03-21T07:15:10.033Z' customer: id: 67cfe5d8d24d7b766d8a2359 firstName: Pablo lastName: López companyName: Cypress e2e Testing paymentMethod: billingAddress: address: 74TH AVE address2: '' country: US city: Miami state: Alaska zipCode: '33122' last4: '0254' customerVaultId: '2946243343' type: credit zipCode: '12656' exp: '1229' name: John Doe network: visa brand: visa number: 476173******0254 bin: '47617320' isSurchargeEligible: true isZipCodeEligible: true paymentMethods: - billingAddress: address: 74TH AVE address2: '' country: US city: Miami state: Alaska zipCode: '33122' last4: '0254' customerVaultId: '2946243343' type: credit zipCode: '12656' exp: '1229' name: John Doe network: visa brand: visa number: 476173******0254 bin: '47617320' isSurchargeEligible: true isZipCodeEligible: true phoneNumber: '1337136745' email: rosypayxero@gmail.com zipCode: '12656' billingAddress: company: '' country: US address: 74TH AVE address2: '' city: Miami state: Alaska shippingAddress: company: '' country: US address: 74TH AVE address2: '' city: Miami state: Alaska firstPayment: {} reference: STR-CYT-250311-07378 order: customValues: - key: customer_code label: Customer Code value: Ramdom123 valueLabel: '' - key: Test1 label: Test1 value: Ramdom123 valueLabel: '' orderDescription: Test note tax: 0 - id: 67d3dd2d9c0e2097d8aadc32 nextPayment: '2025-03-24T04:00:00.000Z' deletedAt: null plan: id: 65a71c40ec0ccce66a6b5c70 payments: 10 amount: 50 untilTerminated: false name: New Plan Test Unico dayFrequency: 3 monthFrequency: 0 dayOfMonth: 0 amount: 50 surcharge: 2 startDate: '2025-03-15T04:00:00.000Z' autoRenew: false notificationMail: false status: running untilTerminated: false createdAt: '2025-03-14T07:39:25.886Z' updatedAt: '2025-03-21T07:15:09.593Z' customer: id: 67d3dd1c997dd06f45e49c60 firstName: Pablo lastName: López companyName: Cypress e2e Testing paymentMethod: billingAddress: address: 74TH AVE address2: '' country: US city: Miami state: Alaska zipCode: '33122' last4: '1202' customerVaultId: '0487006620' type: credit zipCode: '12656' exp: '1229' name: John Doe network: visa brand: visa number: 400551******1202 bin: '40055144' isSurchargeEligible: true isZipCodeEligible: true paymentMethods: - billingAddress: address: 74TH AVE address2: '' country: US city: Miami state: Alaska zipCode: '33122' last4: '1202' customerVaultId: '0487006620' type: credit zipCode: '12656' exp: '1229' name: John Doe network: visa brand: visa number: 400551******1202 bin: '40055144' isSurchargeEligible: true isZipCodeEligible: true phoneNumber: '1337136745' email: rosypayxero@gmail.com zipCode: '12656' billingAddress: company: '' country: US address: 74TH AVE address2: '' city: Miami state: Alaska shippingAddress: company: '' country: US address: 74TH AVE address2: '' city: Miami state: Alaska firstPayment: paymentId: 67d3dd319c0e2097d8aadc45 amount: 121 surcharge: 4 updatedAt: '2025-03-14T07:39:39.869Z' createdAt: '2025-03-14T07:39:39.869Z' reference: STR-CYT-250314-07417 order: customValues: - key: customer_code label: Customer Code value: Ramdom123 valueLabel: '' - key: Test1 label: Test1 value: Ramdom123 valueLabel: '' orderDescription: Test note tax: 0 - id: 67dce538ede928b93358b0f2 nextPayment: '2025-04-07T04:00:00.000Z' deletedAt: null plan: id: 67dce512e2b6d8bad2390924 payments: 3 amount: 30 untilTerminated: false name: API Plan dayFrequency: 0 monthFrequency: 1 dayOfMonth: 7 amount: 30 surcharge: 0 startDate: '2025-03-22T04:00:00.000Z' autoRenew: true notificationMail: true status: running untilTerminated: false createdAt: '2025-03-21T04:04:08.462Z' updatedAt: '2025-03-21T04:04:08.506Z' customer: id: 653fc5c7ac4a672176bbb48c firstName: Rosayda lastName: Valiente Mesa companyName: '' paymentMethod: billingAddress: null last4: '0047' customerVaultId: '9415875278' type: credit zipCode: '12345' exp: '1128' name: Test Postman network: discover brand: discover number: 601197******0047 bin: '60119737' isSurchargeEligible: false isZipCodeEligible: false paymentMethods: - billingAddress: null last4: '0047' customerVaultId: '9415875278' type: credit zipCode: '12345' exp: '1128' name: Test Postman network: discover brand: discover number: 601197******0047 bin: '60119737' isSurchargeEligible: false isZipCodeEligible: false phoneNumber: '6474121454' email: rosita6505@gmail.com zipCode: '12345' billingAddress: company: '' country: US address: '' address2: '' city: '' state: '' shippingAddress: company: '' country: US address: '' address2: '' city: '' state: '' firstPayment: {} reference: STR-CYT-250321-07512 - id: 67dc90adede928b9335889f6 nextPayment: '2025-04-07T04:00:00.000Z' deletedAt: null plan: id: 67dc9087e2b6d8bad238f018 payments: 3 amount: 30 untilTerminated: false name: API Plan dayFrequency: 0 monthFrequency: 1 dayOfMonth: 7 amount: 30 surcharge: 0 startDate: '2025-03-21T04:00:00.000Z' autoRenew: true notificationMail: true status: running untilTerminated: false createdAt: '2025-03-20T22:03:25.723Z' updatedAt: '2025-03-20T22:03:25.774Z' customer: id: 653fc5c7ac4a672176bbb48c firstName: Rosayda lastName: Valiente Mesa companyName: '' paymentMethod: billingAddress: null last4: '0047' customerVaultId: '9415875278' type: credit zipCode: '12345' exp: '1128' name: Test Postman network: discover brand: discover number: 601197******0047 bin: '60119737' isSurchargeEligible: false isZipCodeEligible: false paymentMethods: - billingAddress: null last4: '0047' customerVaultId: '9415875278' type: credit zipCode: '12345' exp: '1128' name: Test Postman network: discover brand: discover number: 601197******0047 bin: '60119737' isSurchargeEligible: false isZipCodeEligible: false phoneNumber: '6474121454' email: rosita6505@gmail.com zipCode: '12345' billingAddress: company: '' country: US address: '' address2: '' city: '' state: '' shippingAddress: company: '' country: US address: '' address2: '' city: '' state: '' firstPayment: {} reference: STR-CYT-250320-07510 example2: summary: List Subscription By Customer Identifier value: meta: count: 354 totalPages: 36 page: 1 limit: 10 data: - id: 676b91eb48fd65c69fec8105 nextPayment: '2025-04-07T04:00:00.000Z' deletedAt: null plan: id: 676b91c54ea7cae4b6472b04 payments: 3 amount: 30 untilTerminated: false name: API Plan dayFrequency: 0 monthFrequency: 1 dayOfMonth: 7 amount: 30 surcharge: 0 startDate: '2024-12-26T05:00:00.000Z' autoRenew: true notificationMail: true status: running untilTerminated: false createdAt: '2024-12-25T05:02:35.665Z' updatedAt: '2025-03-21T10:45:19.889Z' customer: id: 653fc5c7ac4a672176bbb48c firstName: Rosayda lastName: Valiente Mesa companyName: '' paymentMethod: billingAddress: null last4: '0047' customerVaultId: '9415875278' type: credit zipCode: '12345' exp: '1128' name: Test Postman network: discover brand: discover number: 601197******0047 bin: '60119737' isSurchargeEligible: false isZipCodeEligible: false paymentMethods: - billingAddress: null last4: '0047' customerVaultId: '9415875278' type: credit zipCode: '12345' exp: '1128' name: Test Postman network: discover brand: discover number: 601197******0047 bin: '60119737' isSurchargeEligible: false isZipCodeEligible: false phoneNumber: '6474121454' email: rosita6505@gmail.com zipCode: '12345' billingAddress: company: '' country: US address: '' address2: '' city: '' state: '' shippingAddress: company: '' country: US address: '' address2: '' city: '' state: '' firstPayment: {} reference: STR-CYT-241225-05817 - id: 67dd39b8e2b6d8bad2394b3e nextPayment: '2025-04-07T04:00:00.000Z' deletedAt: null plan: id: 67dd3993ede928b933592483 payments: 3 amount: 30 untilTerminated: false name: API Plan dayFrequency: 0 monthFrequency: 1 dayOfMonth: 7 amount: 30 surcharge: 0 startDate: '2025-03-22T04:00:00.000Z' autoRenew: true notificationMail: true status: running untilTerminated: false createdAt: '2025-03-21T10:04:40.927Z' updatedAt: '2025-03-21T10:04:40.965Z' customer: id: 653fc5c7ac4a672176bbb48c firstName: Rosayda lastName: Valiente Mesa companyName: '' paymentMethod: billingAddress: null last4: '0047' customerVaultId: '9415875278' type: credit zipCode: '12345' exp: '1128' name: Test Postman network: discover brand: discover number: 601197******0047 bin: '60119737' isSurchargeEligible: false isZipCodeEligible: false paymentMethods: - billingAddress: null last4: '0047' customerVaultId: '9415875278' type: credit zipCode: '12345' exp: '1128' name: Test Postman network: discover brand: discover number: 601197******0047 bin: '60119737' isSurchargeEligible: false isZipCodeEligible: false phoneNumber: '6474121454' email: rosita6505@gmail.com zipCode: '12345' billingAddress: company: '' country: US address: '' address2: '' city: '' state: '' shippingAddress: company: '' country: US address: '' address2: '' city: '' state: '' firstPayment: {} reference: STR-CYT-250321-07521 - id: 676a95264ea7cae4b646d5fa nextPayment: '2025-04-05T04:00:00.000Z' deletedAt: null plan: id: 65494245374c233607906c59 payments: 0 amount: 200 untilTerminated: true name: test subs dayFrequency: 15 monthFrequency: 0 dayOfMonth: 0 amount: 200 surcharge: 0 startDate: '2025-01-20T05:00:00.000Z' autoRenew: true notificationMail: true status: running untilTerminated: true createdAt: '2024-12-24T11:04:06.245Z' updatedAt: '2025-03-21T07:15:15.564Z' customer: id: 653fc5c7ac4a672176bbb48c firstName: Rosayda lastName: Valiente Mesa companyName: '' paymentMethod: billingAddress: null last4: '0047' customerVaultId: '9415875278' type: credit zipCode: '12345' exp: '1128' name: Test Postman network: discover brand: discover number: 601197******0047 bin: '60119737' isSurchargeEligible: false isZipCodeEligible: false paymentMethods: - billingAddress: null last4: '0047' customerVaultId: '9415875278' type: credit zipCode: '12345' exp: '1128' name: Test Postman network: discover brand: discover number: 601197******0047 bin: '60119737' isSurchargeEligible: false isZipCodeEligible: false phoneNumber: '6474121454' email: rosita6505@gmail.com zipCode: '12345' billingAddress: company: '' country: US address: '' address2: '' city: '' state: '' shippingAddress: company: '' country: US address: '' address2: '' city: '' state: '' firstPayment: {} reference: STR-CYT-241224-05808 order: customValues: - key: customer_code label: Customer Code value: '2523' valueLabel: '' tax: 0 - id: 67dce538ede928b93358b0f2 nextPayment: '2025-04-07T04:00:00.000Z' deletedAt: null plan: id: 67dce512e2b6d8bad2390924 payments: 3 amount: 30 untilTerminated: false name: API Plan dayFrequency: 0 monthFrequency: 1 dayOfMonth: 7 amount: 30 surcharge: 0 startDate: '2025-03-22T04:00:00.000Z' autoRenew: true notificationMail: true status: running untilTerminated: false createdAt: '2025-03-21T04:04:08.462Z' updatedAt: '2025-03-21T04:04:08.506Z' customer: id: 653fc5c7ac4a672176bbb48c firstName: Rosayda lastName: Valiente Mesa companyName: '' paymentMethod: billingAddress: null last4: '0047' customerVaultId: '9415875278' type: credit zipCode: '12345' exp: '1128' name: Test Postman network: discover brand: discover number: 601197******0047 bin: '60119737' isSurchargeEligible: false isZipCodeEligible: false paymentMethods: - billingAddress: null last4: '0047' customerVaultId: '9415875278' type: credit zipCode: '12345' exp: '1128' name: Test Postman network: discover brand: discover number: 601197******0047 bin: '60119737' isSurchargeEligible: false isZipCodeEligible: false phoneNumber: '6474121454' email: rosita6505@gmail.com zipCode: '12345' billingAddress: company: '' country: US address: '' address2: '' city: '' state: '' shippingAddress: company: '' country: US address: '' address2: '' city: '' state: '' firstPayment: {} reference: STR-CYT-250321-07512 - id: 67dc90adede928b9335889f6 nextPayment: '2025-04-07T04:00:00.000Z' deletedAt: null plan: id: 67dc9087e2b6d8bad238f018 payments: 3 amount: 30 untilTerminated: false name: API Plan dayFrequency: 0 monthFrequency: 1 dayOfMonth: 7 amount: 30 surcharge: 0 startDate: '2025-03-21T04:00:00.000Z' autoRenew: true notificationMail: true status: running untilTerminated: false createdAt: '2025-03-20T22:03:25.723Z' updatedAt: '2025-03-20T22:03:25.774Z' customer: id: 653fc5c7ac4a672176bbb48c firstName: Rosayda lastName: Valiente Mesa companyName: '' paymentMethod: billingAddress: null last4: '0047' customerVaultId: '9415875278' type: credit zipCode: '12345' exp: '1128' name: Test Postman network: discover brand: discover number: 601197******0047 bin: '60119737' isSurchargeEligible: false isZipCodeEligible: false paymentMethods: - billingAddress: null last4: '0047' customerVaultId: '9415875278' type: credit zipCode: '12345' exp: '1128' name: Test Postman network: discover brand: discover number: 601197******0047 bin: '60119737' isSurchargeEligible: false isZipCodeEligible: false phoneNumber: '6474121454' email: rosita6505@gmail.com zipCode: '12345' billingAddress: company: '' country: US address: '' address2: '' city: '' state: '' shippingAddress: company: '' country: US address: '' address2: '' city: '' state: '' firstPayment: {} reference: STR-CYT-250320-07510 - id: 67dc3c1aede928b933586f7c nextPayment: '2025-04-07T04:00:00.000Z' deletedAt: null plan: id: 67dc3bf4e2b6d8bad238c68f payments: 3 amount: 30 untilTerminated: false name: API Plan dayFrequency: 0 monthFrequency: 1 dayOfMonth: 7 amount: 30 surcharge: 0 startDate: '2025-03-21T04:00:00.000Z' autoRenew: true notificationMail: true status: running untilTerminated: false createdAt: '2025-03-20T16:02:34.683Z' updatedAt: '2025-03-20T16:02:34.734Z' customer: id: 653fc5c7ac4a672176bbb48c firstName: Rosayda lastName: Valiente Mesa companyName: '' paymentMethod: billingAddress: null last4: '0047' customerVaultId: '9415875278' type: credit zipCode: '12345' exp: '1128' name: Test Postman network: discover brand: discover number: 601197******0047 bin: '60119737' isSurchargeEligible: false isZipCodeEligible: false paymentMethods: - billingAddress: null last4: '0047' customerVaultId: '9415875278' type: credit zipCode: '12345' exp: '1128' name: Test Postman network: discover brand: discover number: 601197******0047 bin: '60119737' isSurchargeEligible: false isZipCodeEligible: false phoneNumber: '6474121454' email: rosita6505@gmail.com zipCode: '12345' billingAddress: company: '' country: US address: '' address2: '' city: '' state: '' shippingAddress: company: '' country: US address: '' address2: '' city: '' state: '' firstPayment: {} reference: STR-CYT-250320-07508 - id: 67dbe7f8ede928b933585d6a nextPayment: '2025-04-07T04:00:00.000Z' deletedAt: null plan: id: 67dbe7d2e2b6d8bad238a7d3 payments: 3 amount: 30 untilTerminated: false name: API Plan dayFrequency: 0 monthFrequency: 1 dayOfMonth: 7 amount: 30 surcharge: 0 startDate: '2025-03-21T04:00:00.000Z' autoRenew: true notificationMail: true status: running untilTerminated: false createdAt: '2025-03-20T10:03:36.181Z' updatedAt: '2025-03-20T10:03:36.219Z' customer: id: 653fc5c7ac4a672176bbb48c firstName: Rosayda lastName: Valiente Mesa companyName: '' paymentMethod: billingAddress: null last4: '0047' customerVaultId: '9415875278' type: credit zipCode: '12345' exp: '1128' name: Test Postman network: discover brand: discover number: 601197******0047 bin: '60119737' isSurchargeEligible: false isZipCodeEligible: false paymentMethods: - billingAddress: null last4: '0047' customerVaultId: '9415875278' type: credit zipCode: '12345' exp: '1128' name: Test Postman network: discover brand: discover number: 601197******0047 bin: '60119737' isSurchargeEligible: false isZipCodeEligible: false phoneNumber: '6474121454' email: rosita6505@gmail.com zipCode: '12345' billingAddress: company: '' country: US address: '' address2: '' city: '' state: '' shippingAddress: company: '' country: US address: '' address2: '' city: '' state: '' firstPayment: {} reference: STR-CYT-250320-07507 - id: 67db93a3e2b6d8bad2387efc nextPayment: '2025-04-07T04:00:00.000Z' deletedAt: null plan: id: 67db937cede928b93357f01a payments: 3 amount: 30 untilTerminated: false name: API Plan dayFrequency: 0 monthFrequency: 1 dayOfMonth: 7 amount: 30 surcharge: 0 startDate: '2025-03-21T04:00:00.000Z' autoRenew: true notificationMail: true status: running untilTerminated: false createdAt: '2025-03-20T04:03:47.210Z' updatedAt: '2025-03-20T04:03:47.248Z' customer: id: 653fc5c7ac4a672176bbb48c firstName: Rosayda lastName: Valiente Mesa companyName: '' paymentMethod: billingAddress: null last4: '0047' customerVaultId: '9415875278' type: credit zipCode: '12345' exp: '1128' name: Test Postman network: discover brand: discover number: 601197******0047 bin: '60119737' isSurchargeEligible: false isZipCodeEligible: false paymentMethods: - billingAddress: null last4: '0047' customerVaultId: '9415875278' type: credit zipCode: '12345' exp: '1128' name: Test Postman network: discover brand: discover number: 601197******0047 bin: '60119737' isSurchargeEligible: false isZipCodeEligible: false phoneNumber: '6474121454' email: rosita6505@gmail.com zipCode: '12345' billingAddress: company: '' country: US address: '' address2: '' city: '' state: '' shippingAddress: company: '' country: US address: '' address2: '' city: '' state: '' firstPayment: {} reference: STR-CYT-250320-07498 - id: 67db3f70e2b6d8bad2385c59 nextPayment: '2025-04-07T04:00:00.000Z' deletedAt: null plan: id: 67db3f4aede928b93357cc46 payments: 3 amount: 30 untilTerminated: false name: API Plan dayFrequency: 0 monthFrequency: 1 dayOfMonth: 7 amount: 30 surcharge: 0 startDate: '2025-03-20T04:00:00.000Z' autoRenew: true notificationMail: true status: running untilTerminated: false createdAt: '2025-03-19T22:04:32.489Z' updatedAt: '2025-03-19T22:04:32.551Z' customer: id: 653fc5c7ac4a672176bbb48c firstName: Rosayda lastName: Valiente Mesa companyName: '' paymentMethod: billingAddress: null last4: '0047' customerVaultId: '9415875278' type: credit zipCode: '12345' exp: '1128' name: Test Postman network: discover brand: discover number: 601197******0047 bin: '60119737' isSurchargeEligible: false isZipCodeEligible: false paymentMethods: - billingAddress: null last4: '0047' customerVaultId: '9415875278' type: credit zipCode: '12345' exp: '1128' name: Test Postman network: discover brand: discover number: 601197******0047 bin: '60119737' isSurchargeEligible: false isZipCodeEligible: false phoneNumber: '6474121454' email: rosita6505@gmail.com zipCode: '12345' billingAddress: company: '' country: US address: '' address2: '' city: '' state: '' shippingAddress: company: '' country: US address: '' address2: '' city: '' state: '' firstPayment: {} reference: STR-CYT-250319-07496 - id: 67daeae0fffe272a44a2b70d nextPayment: '2025-04-07T04:00:00.000Z' deletedAt: null plan: id: 67daeabafffe272a44a2b673 payments: 3 amount: 30 untilTerminated: false name: API Plan dayFrequency: 0 monthFrequency: 1 dayOfMonth: 7 amount: 30 surcharge: 0 startDate: '2025-03-20T04:00:00.000Z' autoRenew: true notificationMail: true status: running untilTerminated: false createdAt: '2025-03-19T16:03:44.501Z' updatedAt: '2025-03-19T16:03:44.552Z' customer: id: 653fc5c7ac4a672176bbb48c firstName: Rosayda lastName: Valiente Mesa companyName: '' paymentMethod: billingAddress: null last4: '0047' customerVaultId: '9415875278' type: credit zipCode: '12345' exp: '1128' name: Test Postman network: discover brand: discover number: 601197******0047 bin: '60119737' isSurchargeEligible: false isZipCodeEligible: false paymentMethods: - billingAddress: null last4: '0047' customerVaultId: '9415875278' type: credit zipCode: '12345' exp: '1128' name: Test Postman network: discover brand: discover number: 601197******0047 bin: '60119737' isSurchargeEligible: false isZipCodeEligible: false phoneNumber: '6474121454' email: rosita6505@gmail.com zipCode: '12345' billingAddress: company: '' country: US address: '' address2: '' city: '' state: '' shippingAddress: company: '' country: US address: '' address2: '' city: '' state: '' firstPayment: {} reference: STR-CYT-250319-07495 example3: summary: List Subscription By Customer value: meta: count: 67 totalPages: 7 page: 1 limit: 10 data: - id: 64a6910815f9903adb8aae16 nextPayment: '2023-07-07T04:00:00.000Z' deletedAt: null plan: id: 64907cf194e3dde960596a7c payments: 3 amount: 30 untilTerminated: false name: API Plan dayFrequency: 5 monthFrequency: 1 dayOfMonth: 7 amount: 30 surcharge: 1 startDate: '2023-07-07T00:00:00.000Z' autoRenew: true notificationMail: true active: false untilTerminated: false createdAt: '2023-07-06T10:01:44.542Z' updatedAt: '2023-07-06T10:01:55.167Z' customer: id: 649311b1cf2bc267b6568bd9 firstName: Demo lastName: Documentation companyName: ACME paymentMethod: customerVaultId: '1653471921' last4: '1111' billingAddress: null zipCode: '12345' exp: '1233' name: Demo Card type: credit network: visa brand: visa number: 411111******1111 phoneNumber: '5555555555' email: integration@strictlyzero.com zipCode: '' billingAddress: company: ACME country: US address: '' address2: '' city: demo state: Alaska shippingAddress: company: ACME country: US address: '' address2: '' city: '' state: '' firstPayment: amount: null surcharge: null reference: CODNMITEST-230706-00049 - id: 64a63d4858d397f7ce56f470 nextPayment: '2023-07-07T04:00:00.000Z' deletedAt: null plan: id: 64907cf194e3dde960596a7c payments: 3 amount: 30 untilTerminated: false name: API Plan dayFrequency: 5 monthFrequency: 1 dayOfMonth: 7 amount: 30 surcharge: 1 startDate: '2023-07-07T00:00:00.000Z' autoRenew: true notificationMail: true active: false untilTerminated: false createdAt: '2023-07-06T04:04:24.897Z' updatedAt: '2023-07-06T04:04:35.390Z' customer: id: 649311b1cf2bc267b6568bd9 firstName: Demo lastName: Documentation companyName: ACME paymentMethod: customerVaultId: '1653471921' last4: '1111' billingAddress: null zipCode: '12345' exp: '1233' name: Demo Card type: credit network: visa brand: visa number: 411111******1111 phoneNumber: '5555555555' email: integration@strictlyzero.com zipCode: '' billingAddress: company: ACME country: US address: '' address2: '' city: demo state: Alaska shippingAddress: company: ACME country: US address: '' address2: '' city: '' state: '' firstPayment: amount: null surcharge: null reference: CODNMITEST-230706-00048 - id: 64a63d24e8adf85f21445009 nextPayment: '2023-07-07T04:00:00.000Z' deletedAt: null plan: id: 64907cf194e3dde960596a7c payments: 3 amount: 30 untilTerminated: false name: API Plan dayFrequency: 5 monthFrequency: 1 dayOfMonth: 7 amount: 30 surcharge: 1 startDate: '2023-07-07T00:00:00.000Z' autoRenew: true notificationMail: true active: false untilTerminated: false createdAt: '2023-07-06T04:03:48.787Z' updatedAt: '2023-07-06T04:03:50.327Z' customer: id: 649311b1cf2bc267b6568bd9 firstName: Demo lastName: Documentation companyName: ACME paymentMethod: customerVaultId: '1653471921' last4: '1111' billingAddress: null zipCode: '12345' exp: '1233' name: Demo Card type: credit network: visa brand: visa number: 411111******1111 phoneNumber: '5555555555' email: integration@strictlyzero.com zipCode: '' billingAddress: company: ACME country: US address: '' address2: '' city: demo state: Alaska shippingAddress: company: ACME country: US address: '' address2: '' city: '' state: '' firstPayment: amount: null surcharge: null reference: CODNMITEST-230706-00047 - id: 64a5e86fe8adf85f2144365c nextPayment: '2023-07-07T04:00:00.000Z' deletedAt: null plan: id: 64907cf194e3dde960596a7c payments: 3 amount: 30 untilTerminated: false name: API Plan dayFrequency: 5 monthFrequency: 1 dayOfMonth: 7 amount: 30 surcharge: 1 startDate: '2023-07-06T00:00:00.000Z' autoRenew: true notificationMail: true active: false untilTerminated: false createdAt: '2023-07-05T22:02:23.336Z' updatedAt: '2023-07-05T22:02:34.197Z' customer: id: 649311b1cf2bc267b6568bd9 firstName: Demo lastName: Documentation companyName: ACME paymentMethod: customerVaultId: '1653471921' last4: '1111' billingAddress: null zipCode: '12345' exp: '1233' name: Demo Card type: credit network: visa brand: visa number: 411111******1111 phoneNumber: '5555555555' email: integration@strictlyzero.com zipCode: '' billingAddress: company: ACME country: US address: '' address2: '' city: demo state: Alaska shippingAddress: company: ACME country: US address: '' address2: '' city: '' state: '' firstPayment: amount: null surcharge: null reference: CODNMITEST-230705-00046 - id: 64a59423e221da846e0a124b nextPayment: '2023-07-07T04:00:00.000Z' deletedAt: null plan: id: 64907cf194e3dde960596a7c payments: 3 amount: 30 untilTerminated: false name: API Plan dayFrequency: 5 monthFrequency: 1 dayOfMonth: 7 amount: 30 surcharge: 1 startDate: '2023-07-06T00:00:00.000Z' autoRenew: true notificationMail: true active: false untilTerminated: false createdAt: '2023-07-05T16:02:43.571Z' updatedAt: '2023-07-05T16:02:54.352Z' customer: id: 649311b1cf2bc267b6568bd9 firstName: Demo lastName: Documentation companyName: ACME paymentMethod: customerVaultId: '1653471921' last4: '1111' billingAddress: null zipCode: '12345' exp: '1233' name: Demo Card type: credit network: visa brand: visa number: 411111******1111 phoneNumber: '5555555555' email: integration@strictlyzero.com zipCode: '' billingAddress: company: ACME country: US address: '' address2: '' city: demo state: Alaska shippingAddress: company: ACME country: US address: '' address2: '' city: '' state: '' firstPayment: amount: null surcharge: null reference: CODNMITEST-230705-00044 - id: 64a53f8c5a1fb957590c7fe1 nextPayment: '2023-07-07T04:00:00.000Z' deletedAt: null plan: id: 64907cf194e3dde960596a7c payments: 3 amount: 30 untilTerminated: false name: API Plan dayFrequency: 5 monthFrequency: 1 dayOfMonth: 7 amount: 30 surcharge: 1 startDate: '2023-07-06T00:00:00.000Z' autoRenew: true notificationMail: true active: false untilTerminated: false createdAt: '2023-07-05T10:01:48.764Z' updatedAt: '2023-07-05T10:02:00.309Z' customer: id: 649311b1cf2bc267b6568bd9 firstName: Demo lastName: Documentation companyName: ACME paymentMethod: customerVaultId: '1653471921' last4: '1111' billingAddress: null zipCode: '12345' exp: '1233' name: Demo Card type: credit network: visa brand: visa number: 411111******1111 phoneNumber: '5555555555' email: integration@strictlyzero.com zipCode: '' billingAddress: company: ACME country: US address: '' address2: '' city: demo state: Alaska shippingAddress: company: ACME country: US address: '' address2: '' city: '' state: '' firstPayment: amount: null surcharge: null reference: CODNMITEST-230705-00043 - id: 64a4eb9571d932bc1b2f7caa nextPayment: '2023-07-07T04:00:00.000Z' deletedAt: null plan: id: 64907cf194e3dde960596a7c payments: 3 amount: 30 untilTerminated: false name: API Plan dayFrequency: 5 monthFrequency: 1 dayOfMonth: 7 amount: 30 surcharge: 1 startDate: '2023-07-06T00:00:00.000Z' autoRenew: true notificationMail: true active: false untilTerminated: false createdAt: '2023-07-05T04:03:33.308Z' updatedAt: '2023-07-05T04:03:44.220Z' customer: id: 649311b1cf2bc267b6568bd9 firstName: Demo lastName: Documentation companyName: ACME paymentMethod: customerVaultId: '1653471921' last4: '1111' billingAddress: null zipCode: '12345' exp: '1233' name: Demo Card type: credit network: visa brand: visa number: 411111******1111 phoneNumber: '5555555555' email: integration@strictlyzero.com zipCode: '' billingAddress: company: ACME country: US address: '' address2: '' city: demo state: Alaska shippingAddress: company: ACME country: US address: '' address2: '' city: '' state: '' firstPayment: amount: null surcharge: null reference: CODNMITEST-230705-00042 - id: 64a4eb8571d932bc1b2f7c53 nextPayment: '2023-07-07T04:00:00.000Z' deletedAt: null plan: id: 64907cf194e3dde960596a7c payments: 3 amount: 30 untilTerminated: false name: API Plan dayFrequency: 5 monthFrequency: 1 dayOfMonth: 7 amount: 30 surcharge: 1 startDate: '2023-07-06T00:00:00.000Z' autoRenew: true notificationMail: true active: false untilTerminated: false createdAt: '2023-07-05T04:03:17.793Z' updatedAt: '2023-07-05T04:03:18.818Z' customer: id: 649311b1cf2bc267b6568bd9 firstName: Demo lastName: Documentation companyName: ACME paymentMethod: customerVaultId: '1653471921' last4: '1111' billingAddress: null zipCode: '12345' exp: '1233' name: Demo Card type: credit network: visa brand: visa number: 411111******1111 phoneNumber: '5555555555' email: integration@strictlyzero.com zipCode: '' billingAddress: company: ACME country: US address: '' address2: '' city: demo state: Alaska shippingAddress: company: ACME country: US address: '' address2: '' city: '' state: '' firstPayment: amount: null surcharge: null reference: CODNMITEST-230705-00041 - id: 64a4974471d932bc1b1395ae nextPayment: '2023-07-07T04:00:00.000Z' deletedAt: null plan: id: 64907cf194e3dde960596a7c payments: 3 amount: 30 untilTerminated: false name: API Plan dayFrequency: 5 monthFrequency: 1 dayOfMonth: 7 amount: 30 surcharge: 1 startDate: '2023-07-05T00:00:00.000Z' autoRenew: true notificationMail: true active: false untilTerminated: false createdAt: '2023-07-04T22:03:48.833Z' updatedAt: '2023-07-04T22:04:00.472Z' customer: id: 649311b1cf2bc267b6568bd9 firstName: Demo lastName: Documentation companyName: ACME paymentMethod: customerVaultId: '1653471921' last4: '1111' billingAddress: null zipCode: '12345' exp: '1233' name: Demo Card type: credit network: visa brand: visa number: 411111******1111 phoneNumber: '5555555555' email: integration@strictlyzero.com zipCode: '' billingAddress: company: ACME country: US address: '' address2: '' city: demo state: Alaska shippingAddress: company: ACME country: US address: '' address2: '' city: '' state: '' firstPayment: amount: null surcharge: null reference: CODNMITEST-230704-00040 - id: 64a442ef71d932bc1bfa8f3f nextPayment: '2023-07-07T04:00:00.000Z' deletedAt: null plan: id: 64907cf194e3dde960596a7c payments: 3 amount: 30 untilTerminated: false name: API Plan dayFrequency: 5 monthFrequency: 1 dayOfMonth: 7 amount: 30 surcharge: 1 startDate: '2023-07-05T00:00:00.000Z' autoRenew: true notificationMail: true active: false untilTerminated: false createdAt: '2023-07-04T16:03:59.731Z' updatedAt: '2023-07-04T16:04:11.791Z' customer: id: 649311b1cf2bc267b6568bd9 firstName: Demo lastName: Documentation companyName: ACME paymentMethod: customerVaultId: '1653471921' last4: '1111' billingAddress: null zipCode: '12345' exp: '1233' name: Demo Card type: credit network: visa brand: visa number: 411111******1111 phoneNumber: '5555555555' email: integration@strictlyzero.com zipCode: '' billingAddress: company: ACME country: US address: '' address2: '' city: demo state: Alaska shippingAddress: company: ACME country: US address: '' address2: '' city: '' state: '' firstPayment: amount: null surcharge: null reference: CODNMITEST-230704-00039 security: - bearer: [] summary: List subscriptions tags: - Subscriptions post: description: >- Create a new subscription linked to a plan and a customer vault. **`planId`** is required unless you provide a `customSchedule`. They are mutually exclusive. **`customSchedule`** lets you define a custom plan inline with: `amount`, `dayFrequency`, `dayOfMonth`, `monthFrequency`, `payments`. **`customerVaultId`** or **`customerId`** (both accepted) — links the subscription to a customer vault. The customer's default payment method (card or ACH) is used. **`startDate`** — optional. If omitted, the subscription starts on the next scheduled date. **`autoRenew`** — automatically renew after the last payment cycle. **`notificationMail`** — send receipt notifications via email/SMS. **`attachments`** — file paths from the /upload-attachments endpoint. operationId: createSubscription parameters: - name: authorization required: true in: header schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreatePublicSubscriptionDto' examples: example1: summary: Create Subscription value: planId: 680147aab3bf25d0530ed7a2 customerVaultId: 681dc751412ad03221ee6164 customerId: 681dc751412ad03221ee6164 startDate: '2025-05-01' autoRenew: true notificationMail: true order: customValues: - key: customer_code label: Customer Code value: COD-123 responses: '201': description: Subscription created. content: application/json: examples: example1: summary: Create Subscription value: data: id: 67dd4493ede928b933592dfb nextPayment: '2025-04-02T04:00:00.000Z' deletedAt: null plan: id: 653be0c76708a15947012c19 payments: 12 amount: 7 untilTerminated: false name: Netflix dayFrequency: 0 monthFrequency: 1 dayOfMonth: 2 amount: 7 surcharge: 0 startDate: '2025-03-22T04:00:00.000Z' autoRenew: true notificationMail: true schedule: - date: '2025-04-02T04:00:00.000Z' attempted: false attemptedCount: 0 failed: false failureMessage: null paymentId: null failureCode: null paymentIdFailed: null paidAt: null _id: 67dd4493ede928b933592dfc - date: '2025-05-02T04:00:00.000Z' attempted: false attemptedCount: 0 failed: false failureMessage: null paymentId: null failureCode: null paymentIdFailed: null paidAt: null _id: 67dd4493ede928b933592dfd - date: '2025-06-02T04:00:00.000Z' attempted: false attemptedCount: 0 failed: false failureMessage: null paymentId: null failureCode: null paymentIdFailed: null paidAt: null _id: 67dd4493ede928b933592dfe - date: '2025-07-02T04:00:00.000Z' attempted: false attemptedCount: 0 failed: false failureMessage: null paymentId: null failureCode: null paymentIdFailed: null paidAt: null _id: 67dd4493ede928b933592dff - date: '2025-08-02T04:00:00.000Z' attempted: false attemptedCount: 0 failed: false failureMessage: null paymentId: null failureCode: null paymentIdFailed: null paidAt: null _id: 67dd4493ede928b933592e00 - date: '2025-09-02T04:00:00.000Z' attempted: false attemptedCount: 0 failed: false failureMessage: null paymentId: null failureCode: null paymentIdFailed: null paidAt: null _id: 67dd4493ede928b933592e01 - date: '2025-10-02T04:00:00.000Z' attempted: false attemptedCount: 0 failed: false failureMessage: null paymentId: null failureCode: null paymentIdFailed: null paidAt: null _id: 67dd4493ede928b933592e02 - date: '2025-11-02T04:00:00.000Z' attempted: false attemptedCount: 0 failed: false failureMessage: null paymentId: null failureCode: null paymentIdFailed: null paidAt: null _id: 67dd4493ede928b933592e03 - date: '2025-12-02T05:00:00.000Z' attempted: false attemptedCount: 0 failed: false failureMessage: null paymentId: null failureCode: null paymentIdFailed: null paidAt: null _id: 67dd4493ede928b933592e04 - date: '2026-01-02T05:00:00.000Z' attempted: false attemptedCount: 0 failed: false failureMessage: null paymentId: null failureCode: null paymentIdFailed: null paidAt: null _id: 67dd4493ede928b933592e05 - date: '2026-02-02T05:00:00.000Z' attempted: false attemptedCount: 0 failed: false failureMessage: null paymentId: null failureCode: null paymentIdFailed: null paidAt: null _id: 67dd4493ede928b933592e06 - date: '2026-03-02T05:00:00.000Z' attempted: false attemptedCount: 0 failed: false failureMessage: null paymentId: null failureCode: null paymentIdFailed: null paidAt: null _id: 67dd4493ede928b933592e07 status: running untilTerminated: false createdAt: '2025-03-21T10:50:59.991Z' updatedAt: '2025-03-21T10:51:00.071Z' customer: id: 653fc5c7ac4a672176bbb48c firstName: Rosayda lastName: Valiente Mesa companyName: '' paymentMethod: billingAddress: null last4: '0047' customerVaultId: '9415875278' type: credit zipCode: '12345' exp: '1128' name: Test Postman network: discover brand: discover number: 601197******0047 bin: '60119737' isSurchargeEligible: false isZipCodeEligible: false paymentMethods: - billingAddress: null last4: '0047' customerVaultId: '9415875278' type: credit zipCode: '12345' exp: '1128' name: Test Postman network: discover brand: discover number: 601197******0047 bin: '60119737' isSurchargeEligible: false isZipCodeEligible: false phoneNumber: '6474121454' email: rosita6505@gmail.com zipCode: '12345' billingAddress: company: '' country: US address: '' address2: '' city: '' state: '' shippingAddress: company: '' country: US address: '' address2: '' city: '' state: '' firstPayment: {} reference: STR-CYT-250321-07522 order: customValues: - key: customer_code label: Customer Code value: COD-123 valueLabel: '' tax: 0 example2: summary: Create Subscription with payment method ach value: data: id: 6491c4f308a0cf10b718f4a3 nextPayment: '2023-07-07T04:00:00.000Z' deletedAt: null plan: id: 64907cf194e3dde960596a7c payments: 3 amount: 30 untilTerminated: false name: API Plan dayFrequency: 5 monthFrequency: 1 dayOfMonth: 7 amount: 30 surcharge: 0 startDate: '2023-06-21T00:00:00.000Z' autoRenew: true notificationMail: true schedule: - date: '2023-07-07T04:00:00.000Z' attempted: false attemptedCount: 0 failed: false failureMessage: null paymentId: null failureCode: null paymentIdFailed: null paidAt: null _id: 6491c4f308a0cf10b718f4a4 - date: '2023-08-07T04:00:00.000Z' attempted: false attemptedCount: 0 failed: false failureMessage: null paymentId: null failureCode: null paymentIdFailed: null paidAt: null _id: 6491c4f308a0cf10b718f4a5 - date: '2023-09-07T04:00:00.000Z' attempted: false attemptedCount: 0 failed: false failureMessage: null paymentId: null failureCode: null paymentIdFailed: null paidAt: null _id: 6491c4f308a0cf10b718f4a6 active: true untilTerminated: false createdAt: '2023-06-20T15:25:39.046Z' updatedAt: '2023-06-20T15:25:39.081Z' customer: id: 63c9c53b6ff0df001ceb864b firstName: Jhon lastName: Doe companyName: '' paymentMethod: firstName: Jhon lastName: Doe phoneNumber: '1212121212' driverLicenseNumber: '1212' accountType: personalChecking routingNumber: '490000018' billingAddress: address: '1212' address2: null country: US city: asas state: Arizona zipCode: '12121' last4: '9999' customerVaultId: 05944FB3E1DA4663868455AF630F45BE companyName: '' type: ach phoneNumber: '3212121212' email: integration@strictlyzero.com zipCode: '' billingAddress: company: '' country: US address: '' address2: '' city: asas state: Arizona shippingAddress: company: '' country: US address: '' address2: '' city: '' state: '' firstPayment: amount: null surcharge: null reference: CODNMITEST-10b718f4a3 order: customValues: - key: customer_code label: Customer Code value: COD-123 example3: summary: Create Subscription with payment method credit/debit card value: data: id: 6491c64d08a0cf10b718f4e6 nextPayment: '2023-07-07T04:00:00.000Z' deletedAt: null plan: id: 64907cf194e3dde960596a7c payments: 3 amount: 30 untilTerminated: false name: API Plan dayFrequency: 5 monthFrequency: 1 dayOfMonth: 7 amount: 30 surcharge: 1 startDate: '2023-06-21T00:00:00.000Z' autoRenew: true notificationMail: true schedule: - date: '2023-07-07T04:00:00.000Z' attempted: false attemptedCount: 0 failed: false failureMessage: null paymentId: null failureCode: null paymentIdFailed: null paidAt: null _id: 6491c64d08a0cf10b718f4e7 - date: '2023-08-07T04:00:00.000Z' attempted: false attemptedCount: 0 failed: false failureMessage: null paymentId: null failureCode: null paymentIdFailed: null paidAt: null _id: 6491c64d08a0cf10b718f4e8 - date: '2023-09-07T04:00:00.000Z' attempted: false attemptedCount: 0 failed: false failureMessage: null paymentId: null failureCode: null paymentIdFailed: null paidAt: null _id: 6491c64d08a0cf10b718f4e9 active: true untilTerminated: false createdAt: '2023-06-20T15:31:25.451Z' updatedAt: '2023-06-20T15:31:25.494Z' customer: id: 647a6f4ac645566e96ecfd73 firstName: test lastName: support companyName: New paymentMethod: customerVaultId: '1845737336' last4: '1121' billingAddress: null zipCode: '12345' exp: '1233' name: Jhon Doe type: credit network: visa brand: visa number: 411111****1121 phoneNumber: '5555555555' email: integration@strictlyzero.com zipCode: '' billingAddress: company: New country: US address: '' address2: '' city: '' state: Drumba shippingAddress: company: New country: US address: '' address2: '' city: '' state: '' firstPayment: amount: null surcharge: null reference: CODNMITEST-10b718f4e6 order: customValues: - key: customer_code label: Customer Code value: COD-123 '400': description: Bad Request '401': description: Unauthorized security: - bearer: [] summary: Create subscription tags: - Subscriptions /v1/public/subscription/{id}: get: description: Retrieve a single subscription by ID. operationId: getSubscription parameters: - name: id required: true in: path description: Subscription ID schema: type: string responses: '200': description: Subscription returned. content: application/json: examples: example1: summary: Get Subscription value: data: id: 677083cd6db48a88dcf69ae8 nextPayment: '2025-03-07T05:00:00.000Z' deletedAt: '2025-03-21T10:04:24.184Z' plan: id: 677083a8c2cbe0b217e6de69 payments: 3 amount: 30 untilTerminated: false name: API Plan dayFrequency: 0 monthFrequency: 1 dayOfMonth: 7 amount: 30 surcharge: 0 startDate: '2024-12-29T05:00:00.000Z' autoRenew: true notificationMail: true schedule: - date: '2025-01-07T05:00:00.000Z' attempted: true attemptedCount: 1 failed: false failureMessage: null paymentId: 677ce29bdd85ae5ac0351652 failureCode: null paymentIdFailed: null paidAt: '2025-01-07T08:15:23.973Z' _id: 677083cd6db48a88dcf69ae9 - date: '2025-02-07T05:00:00.000Z' attempted: true attemptedCount: 1 failed: false failureMessage: null paymentId: 67a5c185a0087892440df54f failureCode: null paymentIdFailed: null paidAt: '2025-02-07T08:17:09.382Z' _id: 677083cd6db48a88dcf69aea status: inactive untilTerminated: false createdAt: '2024-12-28T23:03:41.798Z' updatedAt: '2025-03-21T10:04:29.613Z' customer: id: 6626928346b0eb29ca8b3ff4 firstName: Demo lastName: Documentation companyName: ACME Updated paymentMethod: billingAddress: null last4: '1111' customerVaultId: '5317318150' type: credit zipCode: '12345' exp: '1233' name: Demo Card network: mastercard brand: mastercard number: 411111******1111 isSurchargeEligible: true isZipCodeEligible: false paymentMethods: - billingAddress: null last4: '1111' customerVaultId: '5317318150' type: credit zipCode: '12345' exp: '1233' name: Demo Card network: mastercard brand: mastercard number: 411111******1111 isSurchargeEligible: true isZipCodeEligible: false - billingAddress: address: 23462 Street country: US city: Miami state: Florida zipCode: '12345' last4: '1111' customerVaultId: '7079313069' type: credit zipCode: '12345' exp: '1233' name: Demo Card network: mastercard brand: mastercard number: 411111******1111 bin: '411111' isSurchargeEligible: true isZipCodeEligible: false - billingAddress: address: 23462 Street country: US city: Miami state: Florida zipCode: '12345' last4: '1111' customerVaultId: '3194209410' type: credit zipCode: '12345' exp: '1233' name: Demo Card network: mastercard brand: mastercard number: 411111******1111 bin: '411111' isSurchargeEligible: true isZipCodeEligible: false - billingAddress: address: 23462 Street country: US city: Miami state: Florida zipCode: '12345' last4: '1111' customerVaultId: '7887644659' type: credit zipCode: '12345' exp: '1233' name: Demo Card network: mastercard brand: mastercard number: 411111******1111 bin: '411111' isSurchargeEligible: true isZipCodeEligible: false - billingAddress: address: 23462 Street country: US city: Miami state: Florida zipCode: '12345' last4: '1111' customerVaultId: '6687376536' type: credit zipCode: '12345' exp: '1233' name: Demo Card network: mastercard brand: mastercard number: 411111******1111 bin: '411111' isSurchargeEligible: true isZipCodeEligible: false - billingAddress: address: 23462 Street country: US city: Miami state: Florida zipCode: '12345' last4: '1111' customerVaultId: '0037266832' type: credit zipCode: '12345' exp: '1233' name: Demo Card network: mastercard brand: mastercard number: 411111******1111 bin: '411111' isSurchargeEligible: true isZipCodeEligible: false - billingAddress: address: 23462 Street country: US city: Miami state: Florida zipCode: '12345' last4: '0004' customerVaultId: '8954860990' type: credit zipCode: '12345' exp: '1233' name: Demo Card network: discover brand: discover number: 601190******0004 bin: '601190' isSurchargeEligible: true isZipCodeEligible: false - billingAddress: address: 23462 Street country: US city: Miami state: Florida zipCode: '12345' last4: '5559' customerVaultId: '5559642221' type: credit zipCode: '12345' exp: '1233' name: Demo Card network: discover brand: discover number: 601130******5559 bin: '601130' isSurchargeEligible: true isZipCodeEligible: false phoneNumber: '5555555555' email: integration@strictlyzero.com zipCode: '12345' billingAddress: company: Cypress e2e Testing country: US address: demo address2: '' city: demo state: Alaska shippingAddress: company: Cypress e2e Testing country: US address: '' address2: '' city: Miami state: Alaska firstPayment: {} reference: STR-CYT-241228-05931 example2: summary: Get Subscription with payment method credit/debit card value: data: id: 6491c92c08a0cf10b718f6cf nextPayment: '2023-07-20T04:00:00.000Z' deletedAt: null plan: payments: 2 amount: 120 untilTerminated: false name: Custom dayFrequency: 0 monthFrequency: 1 dayOfMonth: 20 amount: 120 surcharge: 4 startDate: '2023-06-21T00:00:00.000Z' autoRenew: false notificationMail: false schedule: - date: '2023-06-20T04:00:00.000Z' attempted: true attemptedCount: 1 failed: false failureMessage: null paymentId: 6491c977e85d650e961225ec failureCode: null paymentIdFailed: null paidAt: '2023-06-20T15:44:56.160Z' _id: 6491c92c08a0cf10b718f6d0 - date: '2023-07-20T04:00:00.000Z' attempted: false attemptedCount: 0 failed: false failureMessage: null paymentId: null failureCode: null paymentIdFailed: null paidAt: null _id: 6491c92c08a0cf10b718f6d1 active: true untilTerminated: false createdAt: '2023-06-20T15:43:40.458Z' updatedAt: '2023-06-20T15:44:56.291Z' customer: id: 647a6f4ac645566e96ecfd73 firstName: test lastName: support companyName: New paymentMethod: customerVaultId: '1845737336' last4: '1121' billingAddress: null zipCode: '12345' exp: '1233' name: Test Support type: credit network: visa brand: visa number: 411111****1121 phoneNumber: '5555555555' email: integration@strictlyzero.com zipCode: '' billingAddress: company: New country: US address: '' address2: '' city: '' state: Drumba shippingAddress: company: New country: US address: '' address2: '' city: '' state: '' firstPayment: amount: null surcharge: null reference: CODNMITEST-10b718f6cf '404': description: Not Found security: - bearer: [] summary: Get a Subscription tags: - Subscriptions patch: description: |- Update an existing subscription. **Updatable fields:** `amount`, `surcharge`, `autoRenew`, `notificationMail`, `customerVaultId`, `attachments`. To change the customer vault (and thus the payment method), provide a new `customerVaultId`. **`attachments`:** Upload files first via /upload-attachments, then pass the file path objects here. operationId: updateSubscription parameters: - name: id required: true in: path description: Subscription ID schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdatePublicSubscriptionDto' examples: example1: summary: Update Subscription value: customerVaultId: 68541ec4e058df3ca853931d surcharge: 0 amount: 25 autoRenew: true notificationMail: true responses: '200': description: Subscription updated. content: application/json: examples: example1: summary: Update Subscription value: data: id: 6789210407d9504b77de65ca nextPayment: '2025-04-01T04:00:00.000Z' deletedAt: null plan: id: 678863de06b72a44c962154e payments: 24 amount: 1000 untilTerminated: false name: Platinum Tier dayFrequency: 0 monthFrequency: 1 dayOfMonth: 1 amount: 1030 surcharge: 0 startDate: '2025-01-17T05:00:00.000Z' autoRenew: true notificationMail: true schedule: - date: '2025-02-01T05:00:00.000Z' attempted: true attemptedCount: 4 failed: false failureMessage: >- {"paymentId":"67a68bbc4aebe8ebdacf00c2","message":"Do not honor. The card issuer is not allowing the transaction. It’s recommended to use another card or contact your bank for more details.","transactionId":"207223953","errorCode":"201"} paymentId: 67a68c914aebe8ebdacf0158 failureCode: null paymentIdFailed: 67a68bbc4aebe8ebdacf00c2 paidAt: '2025-02-07T22:43:29.866Z' _id: 678933aca7b6aba0b0eb3fb7 - date: '2025-03-01T05:00:00.000Z' attempted: false attemptedCount: 0 failed: false failureMessage: null paymentId: null failureCode: null paymentIdFailed: null paidAt: null _id: 67a68c7ee6f8cc5e4388c273 - date: '2025-04-01T04:00:00.000Z' attempted: false attemptedCount: 0 failed: false failureMessage: null paymentId: null failureCode: null paymentIdFailed: null paidAt: null _id: 67a68c7ee6f8cc5e4388c274 - date: '2025-05-01T04:00:00.000Z' attempted: false attemptedCount: 0 failed: false failureMessage: null paymentId: null failureCode: null paymentIdFailed: null paidAt: null _id: 67a68c7ee6f8cc5e4388c275 - date: '2025-06-01T04:00:00.000Z' attempted: false attemptedCount: 0 failed: false failureMessage: null paymentId: null failureCode: null paymentIdFailed: null paidAt: null _id: 67a68c7ee6f8cc5e4388c276 - date: '2025-07-01T04:00:00.000Z' attempted: false attemptedCount: 0 failed: false failureMessage: null paymentId: null failureCode: null paymentIdFailed: null paidAt: null _id: 67a68c7ee6f8cc5e4388c277 - date: '2025-08-01T04:00:00.000Z' attempted: false attemptedCount: 0 failed: false failureMessage: null paymentId: null failureCode: null paymentIdFailed: null paidAt: null _id: 67a68c7ee6f8cc5e4388c278 - date: '2025-09-01T04:00:00.000Z' attempted: false attemptedCount: 0 failed: false failureMessage: null paymentId: null failureCode: null paymentIdFailed: null paidAt: null _id: 67a68c7ee6f8cc5e4388c279 - date: '2025-10-01T04:00:00.000Z' attempted: false attemptedCount: 0 failed: false failureMessage: null paymentId: null failureCode: null paymentIdFailed: null paidAt: null _id: 67a68c7ee6f8cc5e4388c27a - date: '2025-11-01T04:00:00.000Z' attempted: false attemptedCount: 0 failed: false failureMessage: null paymentId: null failureCode: null paymentIdFailed: null paidAt: null _id: 67a68c7ee6f8cc5e4388c27b - date: '2025-12-01T05:00:00.000Z' attempted: false attemptedCount: 0 failed: false failureMessage: null paymentId: null failureCode: null paymentIdFailed: null paidAt: null _id: 67a68c7ee6f8cc5e4388c27c - date: '2026-01-01T05:00:00.000Z' attempted: false attemptedCount: 0 failed: false failureMessage: null paymentId: null failureCode: null paymentIdFailed: null paidAt: null _id: 67a68c7ee6f8cc5e4388c27d - date: '2026-02-01T05:00:00.000Z' attempted: false attemptedCount: 0 failed: false failureMessage: null paymentId: null failureCode: null paymentIdFailed: null paidAt: null _id: 67a68c7ee6f8cc5e4388c27e - date: '2026-03-01T05:00:00.000Z' attempted: false attemptedCount: 0 failed: false failureMessage: null paymentId: null failureCode: null paymentIdFailed: null paidAt: null _id: 67a68c7ee6f8cc5e4388c27f - date: '2026-04-01T04:00:00.000Z' attempted: false attemptedCount: 0 failed: false failureMessage: null paymentId: null failureCode: null paymentIdFailed: null paidAt: null _id: 67a68c7ee6f8cc5e4388c280 - date: '2026-05-01T04:00:00.000Z' attempted: false attemptedCount: 0 failed: false failureMessage: null paymentId: null failureCode: null paymentIdFailed: null paidAt: null _id: 67a68c7ee6f8cc5e4388c281 - date: '2026-06-01T04:00:00.000Z' attempted: false attemptedCount: 0 failed: false failureMessage: null paymentId: null failureCode: null paymentIdFailed: null paidAt: null _id: 67a68c7ee6f8cc5e4388c282 - date: '2026-07-01T04:00:00.000Z' attempted: false attemptedCount: 0 failed: false failureMessage: null paymentId: null failureCode: null paymentIdFailed: null paidAt: null _id: 67a68c7ee6f8cc5e4388c283 - date: '2026-08-01T04:00:00.000Z' attempted: false attemptedCount: 0 failed: false failureMessage: null paymentId: null failureCode: null paymentIdFailed: null paidAt: null _id: 67a68c7ee6f8cc5e4388c284 - date: '2026-09-01T04:00:00.000Z' attempted: false attemptedCount: 0 failed: false failureMessage: null paymentId: null failureCode: null paymentIdFailed: null paidAt: null _id: 67a68c7ee6f8cc5e4388c285 - date: '2026-10-01T04:00:00.000Z' attempted: false attemptedCount: 0 failed: false failureMessage: null paymentId: null failureCode: null paymentIdFailed: null paidAt: null _id: 67a68c7ee6f8cc5e4388c286 - date: '2026-11-01T04:00:00.000Z' attempted: false attemptedCount: 0 failed: false failureMessage: null paymentId: null failureCode: null paymentIdFailed: null paidAt: null _id: 67a68c7ee6f8cc5e4388c287 - date: '2026-12-01T05:00:00.000Z' attempted: false attemptedCount: 0 failed: false failureMessage: null paymentId: null failureCode: null paymentIdFailed: null paidAt: null _id: 67a68c7ee6f8cc5e4388c288 - date: '2027-01-01T05:00:00.000Z' attempted: false attemptedCount: 0 failed: false failureMessage: null paymentId: null failureCode: null paymentIdFailed: null paidAt: null _id: 67a68c7ee6f8cc5e4388c289 - date: '2027-02-01T05:00:00.000Z' attempted: false attemptedCount: 0 failed: false failureMessage: null paymentId: null failureCode: null paymentIdFailed: null paidAt: null _id: 67a68c7ee6f8cc5e4388c28a status: running untilTerminated: false createdAt: '2025-01-16T15:08:52.384Z' updatedAt: '2025-03-21T10:52:15.684Z' customer: id: 64d3d0bc85bc3b0ebe1bc362 firstName: Rosayda lastName: Valiente Mesa companyName: '' paymentMethod: billingAddress: null last4: '0002' paymentToken: c866b69b-b775-458c-8322-033f4d160a4a customerVaultId: '0041900280' type: CARD zipCode: '12562' exp: '1024' name: Rosayda valiente cardType: credit network: visa brand: visa number: 400000******0002 bin: '40000000' isSurchargeEligible: true isZipCodeEligible: true paymentMethods: - billingAddress: null last4: '0002' paymentToken: c866b69b-b775-458c-8322-033f4d160a4a customerVaultId: '0041900280' type: CARD zipCode: '12562' exp: '1024' name: Rosayda valiente cardType: credit network: visa brand: visa number: 400000******0002 bin: '40000000' isSurchargeEligible: true isZipCodeEligible: true phoneNumber: '3143545641' email: rosita6505@gmail.com zipCode: '' billingAddress: firstName: Rosayda lastName: Valiente Mesa company: '' country: US address: '' address2: '' city: '' state: Arkansas zipCode: '' phoneNumber: '3143545641' email: rosita6505@gmail.com shippingAddress: firstName: Rosayda lastName: Valiente Mesa company: '' country: US address: '' address2: '' city: '' state: Arkansas zipCode: '' phoneNumber: '3143545641' email: rosita6505@gmail.com firstPayment: paymentId: 6789210807d9504b77de6741 amount: 100 surcharge: 3 updatedAt: '2025-01-16T15:08:56.734Z' createdAt: '2025-01-16T15:08:56.734Z' reference: PXMER-250116-06439 order: customValues: - key: external-identifier label: External Identifier value: '78' valueLabel: '' tax: 30 example2: summary: Update Subscription value: data: id: EXAMPLE nextPayment: '2022-04-07T04:00:00.000Z' deletedAt: null plan: id: EXAMPLE payments: 3 amount: 30 untilTerminated: false name: API Plan dayFrequency: 5 monthFrequency: 1 dayOfMonth: 7 amount: 30 surcharge: 0 startDate: '2022-03-25T00:00:00.000Z' autoRenew: true notificationMail: true schedule: - date: '2022-04-07T04:00:00.000Z' attempted: false failed: false failureMessage: null paymentId: null paymentIdFailed: null paidAt: null _id: 623c9acf13d7e5001c9042bc - date: '2022-05-07T04:00:00.000Z' attempted: false failed: false failureMessage: null paymentId: null paymentIdFailed: null paidAt: null _id: 623c9acf13d7e5001c9042bb - date: '2022-06-07T04:00:00.000Z' attempted: false failed: false failureMessage: null paymentId: null paymentIdFailed: null paidAt: null _id: 623c9acf13d7e5001c9042ba active: true untilTerminated: false createdAt: '2022-03-24T16:22:39.264Z' updatedAt: '2022-03-24T16:56:18.465Z' customer: id: 622666db03a862001c34e9a4 firstName: Demo lastName: Customer companyName: '' paymentMethod: name: Demo Card number: 411111******1111 network: visa exp: '1122' paymentToken: th4s4yK9-8j788M-2j4sZU-VbWTuXs6SXbY last4: '1111' type: credit customerVaultId: EXAMPLE phoneNumber: EXAMPLE email: EXAMPLE zipCode: '12345' billingAddress: firstName: Demo lastName: Customer company: '' country: US address: '' address2: '' city: '' state: '' zipCode: '12345' phoneNumber: EXAMPLE email: EXAMPLE shippingAddress: firstName: Demo lastName: Customer company: '' country: US address: '' address2: '' city: '' state: '' zipCode: '12345' phoneNumber: EXAMPLE email: EXAMPLE firstPayment: amount: null surcharge: null reference: DEMO-001c9042b9 '404': description: Not Found security: - bearer: [] summary: Update subscription tags: - Subscriptions delete: description: Cancel and delete a subscription. operationId: deleteSubscription parameters: - name: id required: true in: path description: Subscription ID schema: type: string responses: '200': description: Subscription cancelled. content: application/json: examples: example1: summary: Delete Subscription value: data: id: 6769baca5e1c690ff98b881f nextPayment: '2024-12-27T05:00:00.000Z' deletedAt: '2025-03-21T10:54:08.327Z' plan: id: 672330c4121998a5a50116f6 payments: 10 amount: 50 untilTerminated: false name: Plan Test dayFrequency: 3 monthFrequency: 0 dayOfMonth: 0 amount: 50 surcharge: 2 startDate: '2024-12-24T05:00:00.000Z' autoRenew: false notificationMail: false schedule: - date: '2024-12-24T05:00:00.000Z' attempted: true attemptedCount: 1 failed: false failureMessage: null paymentId: 676a6d924ea7cae4b646d002 failureCode: null paymentIdFailed: null paidAt: '2024-12-24T08:15:14.750Z' _id: 6769baca5e1c690ff98b8820 status: inactive untilTerminated: false createdAt: '2024-12-23T19:32:26.451Z' updatedAt: '2025-03-21T10:54:08.327Z' customer: id: 6769bab65e1c690ff98b8810 firstName: Pablo lastName: López companyName: Cypress e2e Testing paymentMethod: billingAddress: address: 74TH AVE address2: '' country: US city: Miami state: Alaska zipCode: '33122' last4: '0029' paymentToken: 642ad46b-0df6-467e-b533-db1272abbd7e customerVaultId: '3278488574' type: CARD zipCode: '12656' exp: '1229' name: John Doe cardType: credit network: visa brand: visa number: 476173******0029 bin: '47617300' isSurchargeEligible: true isZipCodeEligible: true paymentMethods: - billingAddress: address: 74TH AVE address2: '' country: US city: Miami state: Alaska zipCode: '33122' last4: '0029' paymentToken: 642ad46b-0df6-467e-b533-db1272abbd7e customerVaultId: '3278488574' type: CARD zipCode: '12656' exp: '1229' name: John Doe cardType: credit network: visa brand: visa number: 476173******0029 bin: '47617300' isSurchargeEligible: true isZipCodeEligible: true phoneNumber: '1337136745' email: rosypayxero@gmail.com zipCode: '12656' billingAddress: firstName: Pablo lastName: López company: '' country: US address: 74TH AVE address2: '' city: Miami state: Alaska zipCode: '12656' phoneNumber: '1337136745' email: rosypayxero@gmail.com shippingAddress: firstName: Pablo lastName: López company: '' country: US address: 74TH AVE address2: '' city: Miami state: Alaska zipCode: '12656' phoneNumber: '1337136745' email: rosypayxero@gmail.com firstPayment: paymentId: 6769bacf5e1c690ff98b8832 amount: 119 surcharge: 4 updatedAt: '2024-12-23T19:32:32.275Z' createdAt: '2024-12-23T19:32:32.275Z' reference: STR-CYT-241223-05746 order: customValues: - key: customer_code label: Customer Code value: Ramdom123 valueLabel: '' tax: 0 example2: summary: Delete Subscription value: data: id: EXAMPLE nextPayment: '2022-04-07T04:00:00.000Z' deletedAt: null plan: id: EXAMPLE payments: 3 amount: 30 untilTerminated: false name: API Plan dayFrequency: 5 monthFrequency: 1 dayOfMonth: 7 amount: 30 surcharge: 0 startDate: '2022-03-25T00:00:00.000Z' autoRenew: true notificationMail: true schedule: - date: '2022-04-07T04:00:00.000Z' attempted: false failed: false failureMessage: null paymentId: null paymentIdFailed: null paidAt: null _id: 623c9acf13d7e5001c9042bc active: false untilTerminated: false createdAt: '2022-03-24T16:22:39.264Z' updatedAt: '2022-03-24T16:22:39.299Z' customer: id: 622666db03a862001c34e9a4 firstName: Demo lastName: Customer companyName: '' paymentMethod: name: Demo Card number: 411111******1111 network: visa exp: '1122' last4: '1111' type: credit customerVaultId: '398701549' phoneNumber: '1111111111' email: integration@strictlyzero.com zipCode: '12345' billingAddress: company: '' country: US address: '' address2: '' city: '' state: '' shippingAddress: company: '' country: US address: '' address2: '' city: '' state: '' firstPayment: amount: null surcharge: null reference: DEMO-001c9042b9 '404': description: Not Found security: - bearer: [] summary: Delete a subscription tags: - Subscriptions /v1/public/subscription/{subscriptionId}/pause: patch: description: Pause an active subscription. No charges will be processed while paused. Use resume to re-activate. operationId: pauseSubscription parameters: - name: subscriptionId required: true in: path description: Subscription ID schema: type: string responses: '200': description: Subscription paused. content: application/json: examples: example1: summary: Pause Subscription value: data: id: 676b91eb48fd65c69fec8105 nextPayment: null deletedAt: null plan: id: 676b91c54ea7cae4b6472b04 payments: 3 amount: 30 untilTerminated: false name: API Plan dayFrequency: 0 monthFrequency: 1 dayOfMonth: 7 amount: 30 surcharge: 0 startDate: '2024-12-26T05:00:00.000Z' autoRenew: true notificationMail: true schedule: - date: '2025-01-07T05:00:00.000Z' attempted: true attemptedCount: 1 failed: false failureMessage: null paymentId: 677ce292db7be9b5953deda2 failureCode: null paymentIdFailed: null paidAt: '2025-01-07T08:15:14.961Z' _id: 676b91eb48fd65c69fec8106 - date: '2025-02-07T05:00:00.000Z' attempted: true attemptedCount: 1 failed: false failureMessage: null paymentId: 67a5c1579553d57a0de34097 failureCode: null paymentIdFailed: null paidAt: '2025-02-07T08:16:23.822Z' _id: 676b91eb48fd65c69fec8107 - date: '2025-03-07T05:00:00.000Z' attempted: true attemptedCount: 1 failed: false failureMessage: null paymentId: 67caaba93d8959e9135a5958 failureCode: null paymentIdFailed: null paidAt: '2025-03-07T08:17:45.052Z' _id: 676b91eb48fd65c69fec8108 status: paused untilTerminated: false createdAt: '2024-12-25T05:02:35.665Z' updatedAt: '2025-03-21T10:43:20.714Z' customer: id: 653fc5c7ac4a672176bbb48c firstName: Rosayda lastName: Valiente Mesa companyName: '' paymentMethod: billingAddress: null last4: '0047' paymentToken: b036ed25-a74a-41da-9292-23057b494c4a customerVaultId: '9415875278' type: CARD zipCode: '12345' exp: '1128' name: Test Postman cardType: credit network: discover brand: discover number: 601197******0047 bin: '60119737' isSurchargeEligible: false isZipCodeEligible: false paymentMethods: - billingAddress: null last4: '0047' paymentToken: b036ed25-a74a-41da-9292-23057b494c4a customerVaultId: '9415875278' type: CARD zipCode: '12345' exp: '1128' name: Test Postman cardType: credit network: discover brand: discover number: 601197******0047 bin: '60119737' isSurchargeEligible: false isZipCodeEligible: false phoneNumber: '6474121454' email: rosita6505@gmail.com zipCode: '12345' billingAddress: firstName: Rosayda lastName: Valiente Mesa company: '' country: US address: '' address2: '' city: '' state: '' zipCode: '12345' phoneNumber: '6474121454' email: rosita6505@gmail.com shippingAddress: firstName: Rosayda lastName: Valiente Mesa company: '' country: US address: '' address2: '' city: '' state: '' zipCode: '12345' phoneNumber: '6474121454' email: rosita6505@gmail.com firstPayment: {} reference: STR-CYT-241225-05817 '404': description: Not Found security: - bearer: [] summary: Pause subscription tags: - Subscriptions /v1/public/subscription/{subscriptionId}/resume: patch: description: >- Resume a previously paused subscription. Processing resumes either on the day it was unpaused or based on the configured plan settings. Charges will continue as scheduled once resumed. operationId: resumeSubscription parameters: - name: subscriptionId required: true in: path description: Subscription ID schema: type: string responses: '200': description: Subscription resumed. content: application/json: examples: example1: summary: Resume Subscription value: data: id: 676b91eb48fd65c69fec8105 nextPayment: '2025-04-07T04:00:00.000Z' deletedAt: null plan: id: 676b91c54ea7cae4b6472b04 payments: 3 amount: 30 untilTerminated: false name: API Plan dayFrequency: 0 monthFrequency: 1 dayOfMonth: 7 amount: 30 surcharge: 0 startDate: '2024-12-26T05:00:00.000Z' autoRenew: true notificationMail: true schedule: - date: '2025-01-07T05:00:00.000Z' attempted: true attemptedCount: 1 failed: false failureMessage: null paymentId: 677ce292db7be9b5953deda2 failureCode: null paymentIdFailed: null paidAt: '2025-01-07T08:15:14.961Z' _id: 676b91eb48fd65c69fec8106 - date: '2025-02-07T05:00:00.000Z' attempted: true attemptedCount: 1 failed: false failureMessage: null paymentId: 67a5c1579553d57a0de34097 failureCode: null paymentIdFailed: null paidAt: '2025-02-07T08:16:23.822Z' _id: 676b91eb48fd65c69fec8107 - date: '2025-03-07T05:00:00.000Z' attempted: true attemptedCount: 1 failed: false failureMessage: null paymentId: 67caaba93d8959e9135a5958 failureCode: null paymentIdFailed: null paidAt: '2025-03-07T08:17:45.052Z' _id: 676b91eb48fd65c69fec8108 - date: '2025-04-07T04:00:00.000Z' attempted: false attemptedCount: 0 failed: false failureMessage: null paymentId: null failureCode: null paymentIdFailed: null paidAt: null _id: 67dd433fe2b6d8bad239598d - date: '2025-05-07T04:00:00.000Z' attempted: false attemptedCount: 0 failed: false failureMessage: null paymentId: null failureCode: null paymentIdFailed: null paidAt: null _id: 67dd433fe2b6d8bad239598e - date: '2025-06-07T04:00:00.000Z' attempted: false attemptedCount: 0 failed: false failureMessage: null paymentId: null failureCode: null paymentIdFailed: null paidAt: null _id: 67dd433fe2b6d8bad239598f status: running untilTerminated: false createdAt: '2024-12-25T05:02:35.665Z' updatedAt: '2025-03-21T10:45:19.889Z' customer: id: 653fc5c7ac4a672176bbb48c firstName: Rosayda lastName: Valiente Mesa companyName: '' paymentMethod: billingAddress: null last4: '0047' paymentToken: b036ed25-a74a-41da-9292-23057b494c4a customerVaultId: '9415875278' type: CARD zipCode: '12345' exp: '1128' name: Test Postman cardType: credit network: discover brand: discover number: 601197******0047 bin: '60119737' isSurchargeEligible: false isZipCodeEligible: false paymentMethods: - billingAddress: null last4: '0047' paymentToken: b036ed25-a74a-41da-9292-23057b494c4a customerVaultId: '9415875278' type: CARD zipCode: '12345' exp: '1128' name: Test Postman cardType: credit network: discover brand: discover number: 601197******0047 bin: '60119737' isSurchargeEligible: false isZipCodeEligible: false phoneNumber: '6474121454' email: rosita6505@gmail.com zipCode: '12345' billingAddress: firstName: Rosayda lastName: Valiente Mesa company: '' country: US address: '' address2: '' city: '' state: '' zipCode: '12345' phoneNumber: '6474121454' email: rosita6505@gmail.com shippingAddress: firstName: Rosayda lastName: Valiente Mesa company: '' country: US address: '' address2: '' city: '' state: '' zipCode: '12345' phoneNumber: '6474121454' email: rosita6505@gmail.com firstPayment: {} reference: STR-CYT-241225-05817 '404': description: Not Found security: - bearer: [] summary: Resume subscription tags: - Subscriptions /v1/public/subscription/schedule/{scheduleId}/pay: get: description: >- Manually trigger a payment for a failed scheduled entry in a subscription. Provide the `scheduleId` from the subscription's schedule array. operationId: paySubscriptionSchedule parameters: - name: authorization required: true in: header schema: type: string - name: scheduleId required: true in: path description: Schedule entry ID schema: type: string responses: '200': description: Schedule payment retried. content: application/json: examples: example1: summary: Pay Subscription value: data: nextPayment: '2025-04-07T04:00:00.000Z' deletedAt: null plan: id: 676b91c54ea7cae4b6472b04 payments: 3 amount: 30 untilTerminated: false name: API Plan dayFrequency: 0 monthFrequency: 1 dayOfMonth: 7 amount: 30 surcharge: 0 startDate: '2024-12-26T05:00:00.000Z' autoRenew: true notificationMail: true schedule: date: '2025-04-07T04:00:00.000Z' attempted: true attemptedCount: 1 failed: false failureMessage: null paymentId: 67dd3f6fede928b933592d93 failureCode: null paymentIdFailed: null paidAt: 1742552943979 _id: 67ca9f4f3d8959e9135a4153 status: running untilTerminated: false createdAt: '2024-12-25T05:02:35.665Z' updatedAt: '2025-03-07T08:17:45.078Z' customer: id: 653fc5c7ac4a672176bbb48c firstName: Rosayda lastName: Valiente Mesa companyName: '' paymentMethod: billingAddress: null last4: '0047' customerVaultId: '9415875278' type: credit zipCode: '12345' exp: '1128' name: Test Postman network: discover brand: discover number: 601197******0047 bin: '60119737' isSurchargeEligible: false isZipCodeEligible: false paymentMethods: - billingAddress: null last4: '0047' customerVaultId: '9415875278' type: credit zipCode: '12345' exp: '1128' name: Test Postman network: discover brand: discover number: 601197******0047 bin: '60119737' isSurchargeEligible: false isZipCodeEligible: false phoneNumber: '6474121454' email: rosita6505@gmail.com zipCode: '12345' billingAddress: company: '' country: US address: '' address2: '' city: '' state: '' shippingAddress: company: '' country: US address: '' address2: '' city: '' state: '' firstPayment: {} reference: STR-CYT-241225-05817 example2: summary: Pay schedule subscription with payment method ach value: data: nextPayment: '2023-06-20T04:00:00.000Z' deletedAt: null plan: payments: 2 amount: 110 untilTerminated: false name: Custom dayFrequency: 0 monthFrequency: 1 dayOfMonth: 20 amount: 110 surcharge: 0 startDate: '2023-06-21T00:00:00.000Z' autoRenew: false notificationMail: false schedule: date: '2023-06-20T04:00:00.000Z' attempted: true attemptedCount: 1 failed: false failureMessage: null paymentId: 6491c89008a0cf10b718f527 failureCode: null paymentIdFailed: null paidAt: 1687275665064 _id: 6491c85e08a0cf10b718f513 active: true untilTerminated: false createdAt: '2023-06-20T15:40:14.457Z' updatedAt: '2023-06-20T15:40:14.465Z' customer: id: 63c9c53b6ff0df001ceb864b firstName: Jhon lastName: Doe companyName: '' paymentMethod: firstName: Jhon lastName: Doe phoneNumber: '1212121212' driverLicenseNumber: '1212' accountType: personalChecking routingNumber: '490000018' billingAddress: address: '1212' address2: null country: US city: asas state: Arizona zipCode: '12121' last4: '9999' customerVaultId: 05944FB3E1DA4663868455AF630F45BE companyName: '' type: ach phoneNumber: '3212121212' email: integration@strictlyzero.com zipCode: '' billingAddress: company: '' country: US address: '' address2: '' city: asas state: Arizona shippingAddress: company: '' country: US address: '' address2: '' city: '' state: '' firstPayment: amount: null surcharge: null reference: CODNMITEST-10b718f512 '404': description: Not Found security: - bearer: [] summary: Retry failed schedule payment tags: - Subscriptions /v1/public/subscription/upload-attachments: post: description: >- Upload attachment files to associate with a subscription (e.g. contracts, agreements). Use the returned file path objects in the `attachments` field when creating or updating a subscription. **File limits:** Up to 10 files per request, max 25 MB total. **Supported formats:** JPG, PNG, PDF. operationId: uploadSubscriptionAttachments parameters: [] requestBody: required: true content: multipart/form-data: schema: type: object required: - file properties: file: type: array items: type: string format: binary responses: '200': description: Files uploaded. content: application/json: schema: type: object properties: message: type: string files: type: array items: type: object '400': description: Bad Request — file validation failed. security: - bearer: [] summary: Upload subscription attachments tags: - Subscriptions /v1/public/tax: get: description: Returns a paginated list of tax configurations for the authenticated merchant. operationId: listTaxes parameters: - name: page required: false in: query description: Page number for paginating schema: type: number - name: limit required: false in: query description: Limit items per page schema: type: number - name: clientId required: false in: query description: Client identifier schema: type: string - name: authorization required: true in: header schema: type: string responses: '200': description: Paginated taxes list. content: application/json: examples: example1: summary: Tax List value: - percentage: 7 deletedAt: null taxName: Florida createdBy: EXAMPLE createdAt: '2022-03-29T21:00:47.998Z' updatedAt: '2022-03-29T21:00:47.998Z' id: EXAMPLE '401': description: Unauthorized security: - bearer: [] summary: List of Taxes tags: - Taxes /v1/public/terminal/pay: post: description: >- Send a sale transaction request to a physical terminal (BridgePay or Strictly). The terminal will activate and wait for a card payment. The response is **asynchronous** — use `GET /processed-messages/{messageId}` to poll for the result. **Required fields:** `terminalId`, `amount` (in cents, e.g. 100 = $1.00), `receipt` (true/false). **Optional:** `orderNumber`, `email` (if receipt=true), `phone` (if receipt=true), `customValues` array. operationId: terminalPay parameters: - name: authorization required: true in: header schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TerminalPayCreatePublicDto' examples: example1: summary: Pay on Terminal value: terminalId: EXAMPLE_VALUE amount: 100 orderNumber: '12345' receipt: false email: test@example.com phone: 555-555-5555 customValues: - key: customer_code label: Customer Code value: COD-123 responses: '200': description: Request accepted. Poll processed-messages for result. content: application/json: schema: type: object properties: data: type: object '400': description: Bad Request '401': description: Unauthorized security: - bearer: [] summary: Pay on terminal tags: - Terminal /v1/public/terminal/auth: post: description: >- Send a pre-authorization request to a terminal. Reserves funds without capturing. Call `POST /capture` to settle the pre-authorized amount. Same parameters as `/pay`: `terminalId`, `amount` (cents), `receipt`, and optional `orderNumber`, `email`, `phone`. operationId: terminalAuth parameters: - name: authorization required: true in: header schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TerminalPayCreatePublicDto' examples: example1: summary: Auth on Terminal value: terminalId: EXAMPLE_VALUE amount: 80 orderNumber: '12345' receipt: true email: test@example.com phone: 555-555-5555 responses: '200': description: Auth request accepted. '400': description: Bad Request '401': description: Unauthorized security: - bearer: [] summary: Pre-auth on terminal tags: - Terminal /v1/public/terminal/capture: post: description: >- Capture a pre-authorized terminal transaction. Provide `terminalId`, `pnRefNum` (the transaction ID from the pre-auth response), and `amount` in cents. operationId: terminalCapture parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TerminalCaptureRefundDto' examples: example1: summary: Capture on Terminal value: terminalId: EXAMPLE_VALUE amount: 50 pnRefNum: '12087463701' responses: '200': description: Capture request accepted. '400': description: Bad Request '401': description: Unauthorized security: - bearer: [] summary: Capture on terminal tags: - Terminal /v1/public/terminal/void: post: description: >- Void a terminal transaction that has not yet been settled. Provide `terminalId` and `pnRefNum` (the transaction ID from the original pay/auth response). operationId: terminalVoid parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TerminalVoidDto' examples: example1: summary: Void on Terminal value: terminalId: EXAMPLE pnRefNum: '12087763201' responses: '200': description: Void request accepted. content: application/json: examples: example1: summary: Void on Terminal value: data: transactionId: '12087763201' nameOnCard: PEREIRA OJEDA/MAIKEL dateTime: '2021-04-23T22:18:34.605Z' amount: 100 cardType: discover last4: '6614' exp: '0323' type: debit error: false transactionErrorMsg: null '400': description: Bad Request security: - bearer: [] summary: Void on terminal tags: - Terminal /v1/public/terminal/refund: post: description: >- Refund a settled terminal transaction. Provide `terminalId`, `pnRefNum` (transaction ID), and `amount` in cents (e.g. 100 = $1.00). operationId: terminalRefund parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TerminalCaptureRefundDto' examples: example1: summary: Refund on Terminal value: terminalId: EXAMPLE amount: 15 pnRefNum: '12087481401' responses: '200': description: Refund request accepted. content: application/json: examples: example1: summary: Refund on Terminal value: data: transactionId: '12087778401' nameOnCard: PEREIRA OJEDA/MAIKEL dateTime: '2021-04-23T22:19:53.890Z' amount: 65 cardType: discover last4: '6614' exp: '0323' type: credit error: false transactionErrorMsg: null surcharge: 2 '400': description: Bad Request security: - bearer: [] summary: Refund on terminal tags: - Terminal /v1/public/terminal/close-batch: post: description: >- Close the current open settlement batch for a terminal. Triggers settlement processing for all captured transactions in that batch. Provide `terminalId` in the request body. operationId: closeBatch parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TerminalCloseBatchDto' examples: example1: summary: Close-batch on Terminal value: terminalId: EXAMPLE responses: '200': description: Batch closed. content: application/json: examples: example1: summary: Close-batch on Terminal value: amount: 0 status: success deletedAt: null gwRequest: clientId: 5ef0d0a76f1194001bc6accd clientName: joe locationID: F2E05997-0F24-4694-B896-8EC0F48BAABA username: zerodevelop password: Zero@6355 merchantCode: '6562000' merchantAccountCode: '6562001' terminalID: F2E05997-0F24-4694-B896-8EC0F48BAABA tenderType: CREDIT transType: CAPTURE_ALL gwResponse: requestID: f8f61861fe7f1900e0758f4cc0dd26c25d478afb90bf50866fc6c875 locationID: F2E05997-0F24-4694-B896-8EC0F48BAABA terminalID: F2E05997-0F24-4694-B896-8EC0F48BAABA batchId: '688831801' resultCode: '000000' resultTxt: OK timestamp: '20210423181327' createdAt: '2021-04-23T22:13:33.930Z' updatedAt: '2021-04-23T22:13:33.930Z' id: 6083468d92a2bd001b6eb7f7 '400': description: Bad Request security: - bearer: [] summary: Close batch on terminal tags: - Terminal /v1/public/terminal/terminals/close-batch: post: description: Close the settlement batch specifically for Strictly-native terminals. operationId: terminalsCloseBatch parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CloseBatchDTO' examples: example1: summary: Close-batch v2 value: terminalId: EXAMPLE_VALUE responses: '200': description: Batch closed. security: - bearer: [] summary: Close batch (Strictly terminals v2) tags: - Terminal /v1/public/terminal/list: get: description: List all payment terminals (BridgePay or Strictly) associated with a merchant client ID. operationId: listTerminals parameters: - name: page required: false in: query description: 'Page number (default: 1)' schema: type: integer minimum: 1 default: 1 - name: limit required: false in: query description: 'Items per page (default: 25)' schema: type: integer minimum: 1 maximum: 100 default: 25 - name: clientId required: false in: query description: Merchant client ID schema: type: string - name: authorization required: true in: header schema: type: string - name: timezone required: false in: query schema: type: string description: IANA timezone name for date display (e.g. America/New_York) responses: '200': description: Paginated terminals list. content: application/json: examples: example1: summary: List Terminal value: meta: count: 1 totalPages: 1 page: 1 limit: 10 data: - id: 60396394795432001bf37831 name: Front Desk emvEnabled: true signatureEnabled: true contactlessEnabled: true standaloneLocationId: '222222222222222222222222222' semiIntegrationLocationId: '111111111111111111111111' createdBy: EXAMPLE updatedBy: EXAMPLE createdAt: '2021-02-26T21:09:40.679Z' updatedAt: '2021-02-26T21:09:40.679Z' security: - bearer: [] summary: List terminals tags: - Terminal /v1/public/terminal/processed-messages/{messageId}: get: description: >- Poll for the result of an asynchronous terminal operation using the `msgIdentifier` returned by pay/auth/capture/void/refund responses. **Processing statuses:** `received` → `processing` → `complete` | `failed` | `timeout`. Rate limited to **50 requests per minute**. operationId: getProcessedMessage parameters: - name: messageId required: true in: path description: Message identifier (msgIdentifier) returned by a terminal operation schema: type: string responses: '200': description: Processed message details. content: application/json: schema: type: object properties: data: type: object '429': description: Too Many Requests — rate limit exceeded (50 req/min). security: - bearer: [] summary: Poll terminal message status tags: - Terminal /v1/public/tokenize: post: description: >- Tokenize a credit/debit card. Returns a paymentToken that can be passed to charge or customer endpoints in place of raw card data. Requires a merchant tokenizationKey. operationId: tokenizeCard parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TokenizeCardDto' responses: '200': description: Card tokenized successfully. content: application/json: schema: type: object properties: data: type: object properties: token: type: string description: Payment token to use in charge requests '400': description: Bad Request — invalid card data or tokenization key. '401': description: Unauthorized security: - bearer: [] summary: Card tokenization tags: - Tokenize /v1/public/transactions: get: description: >- Returns a paginated list of all transactions (card and ACH). Filter by date range, reference ID, status, amount range, and owner. operationId: listTransactions parameters: - name: page required: false in: query description: Page number for paginating schema: type: number - name: limit required: false in: query description: Limit items per page schema: type: number - name: referenceId required: false in: query description: Like payment by referenceId (transactionId by GateWay) schema: type: string - name: owner required: false in: query description: The owner of the operation schema: type: string - name: statusList required: false in: query description: Filter by status List schema: type: string - name: amount required: false in: query description: Filter by amount range in ctvos (100,500) schema: type: string - name: startDay required: false in: query description: Filter from Start Date schema: type: string - name: endDay required: false in: query description: Filter to End Date schema: type: string - name: failed required: false in: query description: Payment failed schema: type: boolean responses: '200': description: Paginated transactions list. content: application/json: examples: example1: summary: Get Transactions value: meta: count: 18 totalPages: 2 page: '1' limit: '10' data: - id: 6239018aceb02b001cec6be0 transactions: settled: false import: false importAt: null voidable: true _id: 6239018aceb02b001cec6be1 id: 6239018aceb02b001cec6bde object: charge type: sale amount: 207 baseAmount: 200 surcharge: 7 captured: 'true' transactionId: '7080914355' error: false createdAt: '2022-03-21T22:51:54.199Z' transactionAt: '2022-03-21T22:51:54.199Z' userAgent: >- Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/98.0.4758.102 Safari/537.36 device: api paymentId: 6239018aceb02b001cec6be0 createdBy: EXAMPLE updatedBy: EXAMPLE owner: EXAMPLE ownerGroup: null updatedAt: '2022-03-21T22:51:54.359Z' transactionId: '7080914355' createdAt: '2022-03-21T22:51:54.313Z' updatedAt: '2022-03-21T22:51:54.313Z' transactionAt: null clientId: 5ff76fb63bcf0a001c6228e0 clientName: DEMO MERCHANT owner: EXAMPLE card: name: Test Demo number: 411111******1111 paymentToken: EXAMPLE type: credit last4: '1111' network: mastercard contact: phone: EXAMPLE email: EXAMPLE paid: true amount: 200 currency: USD settled: false netAmount: 207 import: false importAt: null status: sale - id: 6238fcd4ceb02b001cec6bc6 transactions: settled: false import: false importAt: null voidable: true _id: 6238fcd4ceb02b001cec6bc7 id: 6238fcd4ceb02b001cec6bc4 object: charge type: sale amount: 104 baseAmount: 100 surcharge: 4 captured: 'true' transactionId: '7080870291' error: false createdAt: '2022-03-21T22:31:48.589Z' transactionAt: '2022-03-21T22:31:48.589Z' userAgent: >- Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/98.0.4758.102 Safari/537.36 device: api paymentId: 6238fcd4ceb02b001cec6bc6 createdBy: EXAMPLE updatedBy: EXAMPLE owner: EXAMPLE ownerGroup: null updatedAt: '2022-03-21T22:31:48.637Z' transactionId: '7080870291' createdAt: '2022-03-21T22:31:48.597Z' updatedAt: '2022-03-21T22:31:48.597Z' transactionAt: null clientId: 5ff76fb63bcf0a001c6228e0 clientName: DEMO MERCHANT owner: EXAMPLE card: name: Test Demo number: 411111******1111 paymentToken: EXAMPLE type: credit last4: '1111' network: mastercard contact: phone: EXAMPLE email: EXAMPLE paid: true amount: 100 currency: USD settled: false netAmount: 104 import: false importAt: null status: sale - id: 6238d425ceb02b001cec6a0e transactions: settled: false import: false importAt: null voidable: true _id: 6238d425ceb02b001cec6a0f id: 6238d425ceb02b001cec6a0c object: charge type: sale amount: 104 baseAmount: 100 surcharge: 4 captured: 'true' transactionId: '7080423806' error: false createdAt: '2022-03-21T19:38:13.767Z' transactionAt: '2022-03-21T19:38:13.767Z' userAgent: >- Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/98.0.4758.102 Safari/537.36 device: api paymentId: 6238d425ceb02b001cec6a0e createdBy: EXAMPLE updatedBy: EXAMPLE owner: EXAMPLE ownerGroup: null updatedAt: '2022-03-21T19:38:13.814Z' transactionId: '7080423806' createdAt: '2022-03-21T19:38:13.779Z' updatedAt: '2022-03-21T19:38:13.779Z' transactionAt: null clientId: 5ff76fb63bcf0a001c6228e0 clientName: DEMO MERCHANT owner: EXAMPLE card: name: Test Demo number: 411111******1111 paymentToken: EXAMPLE type: credit last4: '1111' network: mastercard contact: phone: EXAMPLE email: EXAMPLE paid: true amount: 100 currency: USD settled: false netAmount: 104 import: false importAt: null status: sale '401': description: Unauthorized security: - bearer: [] summary: Get all transactions tags: - Transactions /v1/public/webhooks/avvance: post: description: >- Receive webhook events from the Avvance integration. This endpoint does not require authentication — it should be called by Avvance only. operationId: avvanceWebhook parameters: [] requestBody: required: true content: application/json: schema: type: object additionalProperties: true description: Arbitrary JSON payload from Avvance responses: '200': description: Webhook received and processed. '400': description: Bad Request — payload parse error. security: [] summary: Receive webhook data from Avvance integration tags: - Webhooks info: title: Strictly / PayWithZero Public API description: |- The Strictly payment API is a REST API organized around standard HTTP verbs. All requests must include `Authorization` (HTTP Basic) and `key-hash` headers. **Base URL:** `https://api.paywithzero.net/v1` **Sandbox credentials (demo only):** - Email: `integration@strictlyzero.com` - Password: `demo123*` - key-hash: `BL2H6LGNEUGSXTBARA59` ### Error shape ```json { "statusCode": 400, "timestamp": "2022-04-11T22:54:13.822Z", "path": "/v1/public/payment/charge", "response": { "code": "300", "text": "Transaction was rejected by gateway." }, "message": "Http Exception" } ``` version: 1.0.0 contact: name: Strictly url: https://api.strictlyzero.com email: '' tags: [] servers: - url: https://api.paywithzero.net/v1 description: Production / Sandbox components: securitySchemes: basicAuth: type: http scheme: basic description: Merchant account credentials (email:password Base64-encoded) keyHash: type: apiKey in: header name: key-hash description: API key hash issued to your integration schemas: AchDataDto: type: object properties: paymentToken: type: string description: Payment Token routingNumber: type: string description: ACH Routing Number accountNumber: type: string description: ACH Account Number last4: type: string description: Account number last4 accountType: type: string description: Account type driverLicenseNumber: type: string description: Driver License Number phoneNumber: type: string description: Phone Number required: - routingNumber - accountNumber - last4 - accountType ContactDto: type: object properties: email: type: string description: Contact email address phone: type: string description: Contact phone number AchChargeAddressDto: type: object properties: firstName: type: string description: First name lastName: type: string description: Last name country: type: string description: Billing country address: type: string description: Billing address address2: type: string description: Billing address line 2 city: type: string description: Billing city state: type: string description: Billing state zipCode: type: string description: Billing zip code phoneNumber: type: string description: Billing phone number required: - firstName - lastName - country - address - city - state - zipCode ChargeAddressDto: type: object properties: firstName: type: string description: Cardholder is first name lastName: type: string description: Cardholder is last name country: type: string description: Card billing country address: type: string description: Card billing address address2: type: string description: Card billing address line 2 city: type: string description: Card billing city state: type: string description: Card billing state zipCode: type: string description: Card billing zip code phoneNumber: type: string description: Card billing phone number email: type: string description: Card billing email CustomValuesDto: type: object properties: key: type: string description: Custom Field Key label: type: string description: Custom Field Label value: type: string description: Custom Field Value valueLabel: type: string description: Custom Label Field Value ChargeOrderDto: type: object properties: orderId: type: string description: Order identifier orderDescription: type: string description: Order description poNumber: type: string description: Order PO shipping: type: number description: Order shipping amount tax: type: number description: Order taxes amount federalTaxes: type: number description: Order federalTaxes amount amount: type: number description: Order amount customValues: description: Custom Values type: array items: $ref: '#/components/schemas/CustomValuesDto' discount: type: number description: A positive integer representing how much to discount in the smallest currency unit AchChargePublicDto: type: object properties: clientId: type: string description: Webpage/Application that belongs to a company registered with Zero-Platform, not the current user paying overrideDefaultPaymentMethod: type: string description: The id of the payment method to use in the charge amount: type: number description: A positive integer representing how much to charge in the smallest currency unit currency: type: string description: Three-letter ISO currency code, in lowercase. Must be a supported currency capture: type: boolean description: Whether to immediately capture the charge achData: description: Ach Information allOf: - $ref: '#/components/schemas/AchDataDto' contact: description: Contact Information allOf: - $ref: '#/components/schemas/ContactDto' billingAddress: description: Billing data allOf: - $ref: '#/components/schemas/AchChargeAddressDto' shippingAddress: description: Shipping data allOf: - $ref: '#/components/schemas/ChargeAddressDto' order: description: Order data allOf: - $ref: '#/components/schemas/ChargeOrderDto' sendReceipt: type: boolean description: send Receipt info bypassSurcharge: type: boolean description: Used to remove surcharge amount for exceptions discount: type: number description: A positive integer representing how much to discount in the smallest currency unit customerId: type: string description: Customer ID taxes: description: Taxes amount or list of taxes type: array items: type: string required: - clientId - amount - billingAddress RefundPublicDto: type: object properties: amount: type: number description: The amount to refund, which must be less than or equal to the original amount. paymentId: type: string description: ID of the payment to be refunded. reason: type: string description: Reason for the refund. If set, possible values are duplicate, fraudulent, and requested_by_customer. required: - amount - paymentId - reason VoidPublicDto: type: object properties: paymentId: type: string description: ID of the charge that must be voided. reason: type: string description: Reason that make void. payment: type: string description: Reason that make void. receipt: type: boolean description: To send or not to send an email after void a payment required: - paymentId CardPublicDto: type: object properties: name: type: string description: Name on card number: type: string description: Card number exp: type: string description: Expiration date paymentToken: type: string description: The representative token of the card zipCode: type: string description: Zip code required: - name - number - exp - paymentToken BillingOrShippingAddressPublic: type: object properties: country: type: string description: Country address: type: string description: Address line 1 address2: type: string description: Address line 2 city: type: string description: City state: type: string description: State zipCode: type: string description: Zip Code CustomerPublicDto: type: object properties: clientId: type: string description: Client identifier firstName: type: string description: First Name of the cardholder lastName: type: string description: Last Name of the cardholder zipCode: type: string description: Zip Code cards: description: Customer's card type: array items: $ref: '#/components/schemas/CardPublicDto' phoneNumber: type: string description: Customer's phone number email: type: string description: Customer's email companyName: type: string description: Cardholder's company name (If any) billingAddress: description: Billing Address allOf: - $ref: '#/components/schemas/BillingOrShippingAddressPublic' shippingAddress: description: Shipping Address allOf: - $ref: '#/components/schemas/BillingOrShippingAddressPublic' dateOfBirth: type: string description: Date of birth gender: type: string description: Gender required: - clientId - firstName - lastName - email CustomerUpdatePublicDto: type: object properties: clientId: type: string description: Client identifier firstName: type: string description: First Name of the cardholder lastName: type: string description: Last Name of the cardholder zipCode: type: string description: Zip Code cards: description: Customer's card type: array items: $ref: '#/components/schemas/CardPublicDto' phoneNumber: type: string description: Customer's phone number email: type: string description: Customer's email companyName: type: string description: Cardholder's company name (If any) billingAddress: description: Billing Address allOf: - $ref: '#/components/schemas/BillingOrShippingAddressPublic' shippingAddress: description: Shipping Address allOf: - $ref: '#/components/schemas/BillingOrShippingAddressPublic' dateOfBirth: type: string description: Date of birth gender: type: string description: Gender CustomerBulkActionDto: type: object properties: itemList: description: Bulk Action list of items type: array items: type: string required: - itemList CustomerBulkUpdateRequestDto: type: object properties: itemList: description: Bulk Action list of items type: array items: type: string expirationTime: type: number description: Life time of the request unitOfTime: type: string description: Unit of time (minutes, days, hours, weeks) required: - itemList CustomerUpdateRequestDto: type: object properties: expirationTime: type: number description: Life time of the request unitOfTime: type: string description: Unit of time (minutes, days, hours, weeks) phoneNumber: type: string description: Customer phone number email: type: string description: Customer email address required: - expirationTime - unitOfTime CardBillingAddress: type: object properties: country: type: string description: Country address: type: string description: Address line 1 address2: type: string description: Address line 2 city: type: string description: City state: type: string description: State zipCode: type: string description: Zip Code CustomerCardCreateDto: type: object properties: name: type: string description: Name of card billingAddress: description: Billing Address allOf: - $ref: '#/components/schemas/CardBillingAddress' last4: type: string description: Last4 of card network: type: string description: Type of card (visa, mastercard...) number: type: string description: Number of card exp: type: string description: Exp date of card zipCode: type: string description: Merchant Zipcode customerVaultId: type: string description: Customer Vault Id paymentToken: type: string description: Payment token token: type: string description: Payment token BP CategoryDto: type: object properties: name: type: string description: Category name CreateInvoiceItemDto: type: object properties: name: type: string description: Item name clientId: type: string description: Client identifier description: type: string description: Item descriptions type: type: string description: Item type qty: type: number description: Item quantity salesPrice: type: number description: Item sales price discount: type: number description: Items discount total: type: number description: Items total taxes: description: Item taxes default: null type: array items: type: array categories: description: Item's categories type: array items: $ref: '#/components/schemas/CategoryDto' sku: type: string description: Item type required: - name - clientId - description - type - qty - salesPrice - total - sku CreateBillingDto: type: object properties: firstName: type: string description: Cardholder is first name lastName: type: string description: Cardholder is last name company: type: string description: Cardholder is company country: type: string description: Card billing country address: type: string description: Card billing address address2: type: string description: Card billing address line 2 city: type: string description: Card billing city state: type: string description: Card billing state zipCode: type: string description: Card billing zip code phoneNumber: type: string description: Card billing phone number faxNumber: type: string description: Card billing fax number email: type: string description: Card billing email websiteAddress: type: string description: Card billing web site required: - email CreateShippingDto: type: object properties: firstName: type: string description: Cardholder is first name lastName: type: string description: Cardholder is last name company: type: string description: Cardholder is company country: type: string description: Card billing country address: type: string description: Card billing address address2: type: string description: Card billing address line 2 city: type: string description: Card billing city state: type: string description: Card billing state zipCode: type: string description: Card billing zip code phoneNumber: type: string description: Card billing phone number faxNumber: type: string description: Card billing fax number email: type: string description: Card billing email websiteAddress: type: string description: Card billing web site InvoiceCreateDto: type: object properties: amount: type: number description: Amount of invoicing terms: type: string description: Invoicing terms customValues: description: Custom Values type: array items: $ref: '#/components/schemas/CustomValuesDto' customerId: type: string description: Costumer identifier companyName: type: string description: Company Name currency: type: string description: Payment currency orderDescription: type: string description: Order description shipping: type: number description: Total shipping amount tax: type: number description: Total tax amount paymentId: type: string description: Payment identifier products: description: List of items type: array items: $ref: '#/components/schemas/CreateInvoiceItemDto' billingAddress: description: Billing data allOf: - $ref: '#/components/schemas/CreateBillingDto' shippingAddress: description: Shipping data allOf: - $ref: '#/components/schemas/CreateShippingDto' showBilling: type: boolean description: Show Billing showShipping: type: boolean description: Show Shipping status: type: string description: The status of the invoice createdBy: type: string description: From what application was created updatedBy: type: string description: From what application was updated applyDiscount: type: boolean description: >- A discount may be applied to this invoice. If applicable, a discount of {%} will be deducted from credit card payments. overrideDefaultPaymentMethod: type: string description: The id of the payment method to use in the charge required: - products - billingAddress InvoiceFlexibleCreateDto: type: object properties: amount: type: number description: Amount of invoicing terms: type: string description: Invoicing terms customValues: description: Custom Values type: array items: $ref: '#/components/schemas/CustomValuesDto' customerId: type: string description: Customer identifier companyName: type: string description: Company Name currency: type: string description: Payment currency orderDescription: type: string description: Order description shipping: type: number description: Total shipping amount tax: type: number description: Total tax amount paymentId: type: string description: Payment identifier products: description: List of items type: array items: $ref: '#/components/schemas/CreateInvoiceItemDto' billingAddress: description: Billing data allOf: - $ref: '#/components/schemas/CreateBillingDto' shippingAddress: description: Shipping data allOf: - $ref: '#/components/schemas/CreateShippingDto' showBilling: type: boolean description: Show Billing showShipping: type: boolean description: Show Shipping status: type: string description: The status of the invoice createdBy: type: string description: From what application was created updatedBy: type: string description: From what application was updated applyDiscount: type: boolean description: >- A discount may be applied to this invoice. If applicable, a discount of {%} will be deducted from credit card payments. required: - products - billingAddress SendBySmsDto: type: object properties: paymentLinkId: type: string description: Payment Link Id invoiceId: type: string description: Invoice Id createdBy: type: string description: Name of the user who created the payment link or Invoice phoneNumber: type: string description: Phone to send the payment link or Invoice required: - phoneNumber CreateItemDto: type: object properties: name: type: string description: Item name type: type: string description: Item type description: type: string description: Item description sku: type: string description: Item SKU salesPrice: type: number description: Item sales price categories: description: Item's categories type: array items: $ref: '#/components/schemas/CategoryDto' taxes: description: Item's taxes type: array items: type: string required: - name - type - description - salesPrice ItemBulkActionDto: type: object properties: itemList: description: Bulk Action list of items type: array items: type: string createdBy: type: string description: Username owner of the action required: - itemList PaymentReceiptPdfDto: type: object properties: clientId: type: string description: Webpage/Application that belongs to a company registered with Zero-Platform, not the current user paying paymentId: type: string description: The ID of the payment to which the PDF will be generated isForMerchant: type: boolean description: Indicates if payment receipt is for merchant or customer required: - clientId PaymentMethodDto: type: object properties: type: type: string description: The payment method type accountNumber: type: string description: The check account number checkNumber: type: string description: The check number authCode: type: string description: The check auth code required: - type CardDto: type: object properties: name: type: string description: Card name paymentToken: type: string description: Payment Token vaultId: type: string description: Vault Id customerVaultId: type: string description: Customer Vault Id in the procesor number: type: string description: card number last4: type: string description: card last4 network: type: string description: card network brand: type: string description: Card Brand type: type: string description: Card type bin: type: string description: Card bin zipCode: type: string description: Zip code ChargePublicDto: type: object properties: clientId: type: string description: Webpage/Application that belongs to a company registered with Zero-Platform, not the current user paying overrideDefaultPaymentMethod: type: string description: The id of the payment method to use in the charge paymentMethod: description: Payment Method Information allOf: - $ref: '#/components/schemas/PaymentMethodDto' amount: type: number description: A positive integer representing how much to charge in the smallest currency unit currency: type: string description: Three-letter ISO currency code, in lowercase. Must be a supported currency capture: type: boolean description: Whether to immediately capture the charge card: description: Card Information allOf: - $ref: '#/components/schemas/CardDto' contact: description: Contact Information allOf: - $ref: '#/components/schemas/ContactDto' billingAddress: description: Billing data allOf: - $ref: '#/components/schemas/ChargeAddressDto' shippingAddress: description: Shipping data allOf: - $ref: '#/components/schemas/ChargeAddressDto' order: description: Order data allOf: - $ref: '#/components/schemas/ChargeOrderDto' sendReceipt: type: boolean description: send Receipt info bypassSurcharge: type: boolean description: Used to remove surcharge amount for exceptions discount: type: number description: A positive integer representing how much to discount in the smallest currency unit marketType: type: string description: Market Type zipCode: type: string description: Zip code taxes: description: Taxes amount or list of taxes type: array items: type: string required: - clientId - amount - billingAddress CapturePublicDto: type: object properties: amount: type: number description: The amount to capture, which must be less than or equal to the original amount. paymentId: type: string description: ID of the payment that must be captured. required: - amount BulkChargePayloadDto: type: object properties: customerVaultId: type: string description: Customer's id customerId: type: string description: Customer's id amount: type: number description: A positive integer representing how much to charge in the smallest currency unit bypassSurcharge: type: boolean description: Used to remove surcharge amount for exceptions order: description: Order data allOf: - $ref: '#/components/schemas/ChargeOrderDto' required: - amount BulkChargeDto: type: object properties: clientId: type: string description: Webpage/Application that belongs to a company registered with Zero-Platform, not the current user paying payments: description: Customer's vault id allOf: - $ref: '#/components/schemas/BulkChargePayloadDto' sendReceipt: type: boolean description: send Receipt info required: - clientId - payments CreatePaymentLinkDto: type: object properties: amount: type: number description: Pay amount taxes: description: Taxes amount or list of taxes type: array items: type: string showBilling: type: boolean description: Show Billing showShipping: type: boolean description: Show Shipping customValues: description: custom values data type: array items: $ref: '#/components/schemas/CustomValuesDto' attachments: description: Attachments type: array items: type: string applyDiscount: type: boolean description: >- A discount may be applied to this payment link. If applicable, a discount of {%} will be deducted from credit card payments. required: - amount SendByEmailPublicDto: type: object properties: email: type: string description: Email to send the payment link or Invoice paymentLinkId: type: string description: PaymentLink Id to send by email required: - email CreatePaymentRequestBillingDto: type: object properties: firstName: type: string description: Cardholder is first name lastName: type: string description: Cardholder is last name company: type: string description: Cardholder is company country: type: string description: Card billing country address: type: string description: Card billing address address2: type: string description: Card billing address line 2 city: type: string description: Card billing city state: type: string description: Card billing state zipCode: type: string description: Card billing zip code phoneNumber: type: string description: Card billing phone number faxNumber: type: string description: Card billing fax number email: type: string description: Card billing email websiteAddress: type: string description: Card billing web site required: - email CreatePaymentRequestShippingDto: type: object properties: firstName: type: string description: Cardholder is first name lastName: type: string description: Cardholder is last name company: type: string description: Cardholder is company country: type: string description: Card billing country address: type: string description: Card billing address address2: type: string description: Card billing address line 2 city: type: string description: Card billing city state: type: string description: Card billing state zipCode: type: string description: Card billing zip code phoneNumber: type: string description: Card billing phone number faxNumber: type: string description: Card billing fax number email: type: string description: Card billing email websiteAddress: type: string description: Card billing web site CreatePaymentRequestProductDto: type: object properties: productId: type: string description: Product identifier name: type: string description: Product name description: type: string description: Product descriptions quantity: type: number description: Product quantity cost: type: number description: Product cost tax: type: number description: Product tax discount: type: number description: Product discount total: type: number description: Product tax photo: type: string description: Product photo url required: - productId - name - description - cost - total - photo CreatePaymentRequestDto: type: object properties: clientId: type: string description: Client owned paymentRequest showBilling: type: boolean description: If Billing Address must show in Single Payment Page showShipping: type: boolean description: If Shipping Address must show in Single Payment Page customerId: type: string description: Customer identifier currency: type: string description: Currency orderId: type: string description: Order identifier orderDescription: type: string description: Order descriptions amount: type: number description: Order amount shipping: type: number description: Order shipping tax: type: number description: Order taxes poNumber: type: string description: Order PO Number billingAddress: description: Billing data allOf: - $ref: '#/components/schemas/CreatePaymentRequestBillingDto' shippingAddress: description: Shipping data allOf: - $ref: '#/components/schemas/CreatePaymentRequestShippingDto' products: description: List of products allOf: - $ref: '#/components/schemas/CreatePaymentRequestProductDto' required: - clientId - amount - billingAddress - products CreatePublicPlanDto: type: object properties: payments: type: number description: Number of Payments amount: type: number description: Plan amount name: type: string description: Plan name dayFrequency: type: number description: Plan day frequency monthFrequency: type: number description: Plan month frequency dayOfMonth: type: number description: Plan day of month createdBy: type: string description: From what application was created updatedBy: type: string description: From what application was updated required: - payments - amount - name CustomValues: type: object properties: key: type: string description: Custom value key label: type: string description: Custom value label value: type: string description: Custom value required: - key OrderDto: type: object properties: customValues: description: Custom Values type: array items: $ref: '#/components/schemas/CustomValues' orderDescription: type: string description: Order Description CustomScheduleDto: type: object properties: payments: type: number description: Custom Number of Payments amount: type: number description: Custom Plan amount dayFrequency: type: number description: Custom Plan day frequency monthFrequency: type: number description: Custom Plan month frequency dayOfMonth: type: number description: Custom Plan day of month required: - payments - amount CreatePublicSubscriptionDto: type: object properties: planId: type: string description: Plan Id startDate: type: string description: Start Date order: description: Order allOf: - $ref: '#/components/schemas/OrderDto' customerVaultId: type: string description: Customer ID customerId: type: string description: Customer ID firstAmount: type: number description: First Amount surchargeFirstAmount: type: number description: surcharge First Amount cardFeeFirstAmount: type: number description: Surcharge fee First Amount autoRenew: type: boolean description: Autorenew notificationMail: type: boolean description: Notification Email after autoRenew customSchedule: description: Custom schedule allOf: - $ref: '#/components/schemas/CustomScheduleDto' attachments: description: Attachments type: array items: type: string taxes: description: Taxes amount or list of taxes type: array items: type: string required: - autoRenew UpdatePublicSubscriptionDto: type: object properties: customerVaultId: type: string description: Costumer Id customerId: type: string description: Costumer Id autoRenew: type: boolean description: Autorenew notificationMail: type: boolean description: Notification Email after autoRenew attachments: description: Attachments type: array items: type: string TerminalPayCreatePublicDto: type: object properties: terminalId: type: string description: terminal Id clientId: type: string description: Client Id amount: type: number description: Amount to pay orderNumber: type: string description: Order number receipt: type: boolean description: Receipt email: type: string description: User email phone: type: string description: Phone number doing the payment customValues: description: Custom Values type: array items: $ref: '#/components/schemas/CustomValuesDto' required: - receipt TerminalCaptureRefundDto: type: object properties: clientId: type: string description: Webpage/Application that belongs to a company registered with Zero-Platform, not the current user paying terminalId: type: string description: terminal Id pnRefNum: type: string description: The transaction ID of the payment amount: type: number description: Amount to pay required: - clientId - amount TerminalVoidDto: type: object properties: clientId: type: string description: Webpage/Application that belongs to a company registered with Zero-Platform, not the current user paying terminalId: type: string description: terminal Id pnRefNum: type: string description: The transaction ID of the payment required: - clientId TerminalCloseBatchDto: type: object properties: clientId: type: string description: Webpage/Application that belongs to a company registered with Zero-Platform, not the current user paying terminalId: type: string description: terminal Id required: - clientId CloseBatchDTO: type: object properties: {} TokenizeCardDto: type: object properties: tokenizationKey: type: string description: Merchant tokenization public key ccnumber: type: string description: The card number ccexp: type: string description: The card expiration date cvv: type: string description: The CVV of the card required: - tokenizationKey