Vortex Payments API

Public Vortex Payments API for customers, subscriptions, invoices, payment requests, checkout, receipts, webhooks, tax.

hosted

Hosted payment and customer-facing flows.

• GET
  GET /customer-portal/*/customer-portal/{tail}
• PUT
  PUT /customer-portal/*/customer-portal/{tail}
• POST
  POST /customer-portal/*/customer-portal/{tail}
• DELETE
  DELETE /customer-portal/*/customer-portal/{tail}
• PATCH
  PATCH /customer-portal/*/customer-portal/{tail}
• GET
  GET /invoice/*/invoice/{tail}
• PUT
  PUT /invoice/*/invoice/{tail}
• POST
  POST /invoice/*/invoice/{tail}
• DELETE
  DELETE /invoice/*/invoice/{tail}
• PATCH
  PATCH /invoice/*/invoice/{tail}

public

• GET
  GET /devices/*/devices/{tail}
• PUT
  PUT /devices/*/devices/{tail}
• POST
  POST /devices/*/devices/{tail}
• DELETE
  DELETE /devices/*/devices/{tail}
• PATCH
  PATCH /devices/*/devices/{tail}
• GET
  GET /dispute-portal/*/dispute-portal/{tail}
• PUT
  PUT /dispute-portal/*/dispute-portal/{tail}
• POST
  POST /dispute-portal/*/dispute-portal/{tail}
• DELETE
  DELETE /dispute-portal/*/dispute-portal/{tail}
• PATCH
  PATCH /dispute-portal/*/dispute-portal/{tail}
• GET
  GET /internal/hosted-pay/*/internal/hosted-pay/{tail}
• PUT
  PUT /internal/hosted-pay/*/internal/hosted-pay/{tail}
• POST
  POST /internal/hosted-pay/*/internal/hosted-pay/{tail}
• DELETE
  DELETE /internal/hosted-pay/*/internal/hosted-pay/{tail}
• PATCH
  PATCH /internal/hosted-pay/*/internal/hosted-pay/{tail}
• GET
  GET /merchant-onboarding/*/merchant-onboarding/{tail}
• PUT
  PUT /merchant-onboarding/*/merchant-onboarding/{tail}
• POST
  POST /merchant-onboarding/*/merchant-onboarding/{tail}
• DELETE
  DELETE /merchant-onboarding/*/merchant-onboarding/{tail}
• PATCH
  PATCH /merchant-onboarding/*/merchant-onboarding/{tail}
• GET
  GET /order-form/*/order-form/{tail}
• PUT
  PUT /order-form/*/order-form/{tail}
• POST
  POST /order-form/*/order-form/{tail}
• DELETE
  DELETE /order-form/*/order-form/{tail}
• PATCH
  PATCH /order-form/*/order-form/{tail}

billing

Billing lifecycle routes exposed through Vortex Payments.

• POST
  Create a hosted checkout session. checkoutUrl + token are bearer secrets returned only on creation (hash-only at rest) — GET and idempotent replays return them as null. Persist the create response or mint a fresh session./v1/checkout/sessions
• GET
  Inspect a hosted checkout session. checkoutUrl and token are always null — the redeemable hosted link exists only in the create response./v1/checkout/sessions/{checkoutSessionId}
• GET
  List billing coupons/v1/coupons
• POST
  Create a billing coupon/v1/coupons
• GET
  Get one billing coupon/v1/coupons/{couponId}
• POST
  Create a credit note with explicit line attribution/v1/credit-notes
• GET
  Inspect a credit note and its tax reversal evidence/v1/credit-notes/{creditNoteId}
• POST
  Execute or record a credit-note refund/v1/credit-notes/{creditNoteId}/refund
• GET
  List billing customers, optionally filtered by external ref/v1/customers
• PUT
  Ensure a billing customer exists — dedupes on externalCustomerRef (first) or customerId/v1/customers
• POST
  Create a billing customer/v1/customers
• PUT
  Create or update a billing customer/v1/customers/{customerId}
• GET
  Check product-facing customer access for one entitlement key/v1/customers/{customerId}/access
• GET
  Return a customer's prepaid balance ledger/v1/customers/{customerId}/balance
• GET
  Get effective customer entitlements/v1/customers/{customerId}/entitlements
• GET
  Get product-facing customer billing and access state/v1/customers/{customerId}/state
• POST
  Grant a customer entitlement/v1/entitlements/grant
• POST
  Revoke a customer entitlement/v1/entitlements/revoke
• GET
  List outbound webhook events/v1/events
• GET
  List invoices across the merchant/v1/invoices
• POST
  Create a draft invoice/v1/invoices
• GET
  Get an invoice/v1/invoices/{invoiceId}
• POST
  Collect an open invoice/v1/invoices/{invoiceId}/collect
• POST
  Finalize a draft invoice/v1/invoices/{invoiceId}/finalize
• POST
  Mark an invoice uncollectible/v1/invoices/{invoiceId}/mark-uncollectible
• POST
  Finalize tax evidence for an invoice/v1/invoices/{invoiceId}/tax/finalize
• DELETE
  Void a draft or open invoice/v1/invoices/{invoiceId}/void
• GET
  List merchant accounts for the caller's organization/v1/merchant-accounts
• POST
  Create a sub-merchant account/v1/merchant-accounts
• GET
  Get a merchant account snapshot/v1/merchant-accounts/{merchantAccountId}
• PATCH
  Update merchant account profile fields (draft-friendly)/v1/merchant-accounts/{merchantAccountId}
• GET
  Get merchant payments capability state/v1/merchant-accounts/{merchantAccountId}/capabilities
• POST
  Create a hosted merchant onboarding link/v1/merchant-accounts/{merchantAccountId}/onboarding-link
• GET
  Get onboarding session state and outstanding requirements/v1/merchant-accounts/{merchantAccountId}/onboarding/{onboardingId}
• POST
  Submit a draft merchant for underwriting — the activation step after create/v1/merchant-accounts/{merchantAccountId}/onboarding/submit
• GET
  Get merchant payout profile/v1/merchant-accounts/{merchantAccountId}/payout-profile
• GET
  Get merchant payments readiness state/v1/merchant-accounts/{merchantAccountId}/state
• GET
  Get merchant tax profile/v1/merchant-accounts/{merchantAccountId}/tax-profile
• PUT
  Create or update merchant tax profile/v1/merchant-accounts/{merchantAccountId}/tax-profile
• GET
  List order forms by customer or status/v1/order-forms
• GET
  Inspect an order form with its quote and version/v1/order-forms/{orderFormId}
• POST
  Mark an order form signed, attach a signed document reference, and create the order/v1/order-forms/{orderFormId}/sign
• POST
  Register an external signature request (envelope/session) reference on a generated order form/v1/order-forms/{orderFormId}/signature-request
• POST
  Void a generated order form and cascade-void its quote version/v1/order-forms/{orderFormId}/void
• POST
  Expire generated order forms past their expiry and cascade-void their versions/v1/order-forms/expire-due
• GET
  List orders by customer or execution status/v1/orders
• GET
  Inspect an order with its execution record/v1/orders/{orderId}
• PATCH
  Set or change execution settings on a created order/v1/orders/{orderId}
• POST
  Open an amendment on an executed BillingOrder; returns its lineage-stamped amendment quote/v1/orders/{orderId}/amend
• POST
  Execute a created order into an invoice or subscription per its order type/v1/orders/{orderId}/execute
• POST
  Execute created orders whose scheduled execution time has passed/v1/orders/execute-due
• POST
  Create a one-time document payable/v1/payables
• GET
  List payment receipts/v1/payment-receipts
• GET
  List payment requests by customer, account, request status, or latest attempt status/v1/payment-requests
• POST
  Create a hosted payment request for one or more recoverable invoices/v1/payment-requests
• GET
  Inspect a payment request and its grouped invoices/v1/payment-requests/{paymentRequestId}
• POST
  Collect all eligible invoices in a payment request/v1/payment-requests/{paymentRequestId}/collect
• POST
  Create an expiring hosted payment link for a payment request/v1/payment-requests/{paymentRequestId}/links
• POST
  Create a catalog price/v1/prices
• POST
  Create a catalog product/v1/products
• GET
  Inspect one quote version with its billing snapshot/v1/quote-versions/{quoteVersionId}
• PATCH
  Edit a draft quote version's lines, terms, or currency/v1/quote-versions/{quoteVersionId}
• POST
  Approve a draft quote version and generate its order form/v1/quote-versions/{quoteVersionId}/approve
• POST
  Void a draft quote version/v1/quote-versions/{quoteVersionId}/void
• GET
  List billing quotes by customer or account/v1/quotes
• POST
  Create a billing quote with its first draft version from catalog price lines/v1/quotes
• GET
  Inspect a quote with its version history and current version/v1/quotes/{quoteId}
• GET
  List all versions of a quote/v1/quotes/{quoteId}/versions
• POST
  Open a new draft version for a quote once the prior version is voided/v1/quotes/{quoteId}/versions
• GET
  List subscriptions across the merchant/v1/subscriptions
• POST
  Create a subscription/v1/subscriptions
• GET
  List tax transactions across the merchant/v1/tax-transactions
• POST
  Quote tax for a source document (creates a quoted transaction)/v1/tax-transactions
• GET
  Get a tax transaction/v1/tax-transactions/{taxTransactionId}
• POST
  Commit a quoted tax transaction/v1/tax-transactions/{taxTransactionId}/finalize
• POST
  Reverse a finalized tax transaction (creates a credit-note reversal)/v1/tax-transactions/{taxTransactionId}/reverse
• GET
  List usage events across the merchant/v1/usage-events
• POST
  Record a metered usage event (idempotent by key)/v1/usage-events
• GET
  List configured usage thresholds/v1/usage-thresholds
• POST
  Configure a usage threshold on a meter (customerId omitted = meter-wide); emits usage.threshold_reached when the windowed aggregate crosses/v1/usage-thresholds
• POST
  Archive a usage threshold (stops evaluation)/v1/usage-thresholds/{thresholdId}/archive
• GET
  List outbound webhook deliveries/v1/webhook-deliveries
• POST
  Dispatch pending outbound webhook deliveries/v1/webhook-deliveries/dispatch
• GET
  List outbound webhook endpoints/v1/webhook-endpoints
• POST
  Create an outbound webhook endpoint/v1/webhook-endpoints
• POST
  Create a recurring document payable/v1/recurring-payables
• POST
  Create an installment document payable/v1/installment-payables
• POST
  Create a deposit + balance document payable/v1/deposit-balance-payables
• POST
  Preview a subscription item change/v1/subscriptions/{subscriptionId}/change/preview
• POST
  Change subscription status or items/v1/subscriptions/{subscriptionId}/change
• GET
  List customer payment methods/v1/customers/{customerId}/payment-methods
• POST
  Attach a customer payment method from a setup session/v1/customers/{customerId}/payment-methods
• POST
  Create a customer payment method setup session/v1/customers/{customerId}/payment-method-setup
• PATCH
  Set a customer default payment method/v1/customers/{customerId}/default-payment-method
• POST
  Archive a customer payment method/v1/customers/{customerId}/payment-methods/{paymentMethodId}/archive
• POST
  Submit the microdeposit statement code for a pending bank payment method/v1/customers/{customerId}/payment-methods/{paymentMethodId}/verify-microdeposit
• GET
  Get live provider microdeposit state for a pending bank payment method/v1/customers/{customerId}/payment-methods/{paymentMethodId}/microdeposit-status
• GET
  Get customer payment readiness/v1/customers/{customerId}/payment-state
• GET
  List merchant settlements/v1/merchant-accounts/{merchantAccountId}/settlements
• GET
  List merchant payouts/v1/merchant-accounts/{merchantAccountId}/payouts
• GET
  List outbound webhook event types/v1/webhook-event-types
• DELETE
  Delete an outbound webhook endpoint/v1/webhook-endpoints/{endpointId}
• PATCH
  Update an outbound webhook endpoint/v1/webhook-endpoints/{endpointId}
• POST
  Create and optionally dispatch a test webhook delivery/v1/webhook-endpoints/{endpointId}/test
• POST
  Rotate an outbound webhook signing secret/v1/webhook-endpoints/{endpointId}/rotate-secret
• GET
  Inspect an outbound webhook event/v1/events/{eventId}
• POST
  Create a new delivery for an existing webhook event/v1/events/{eventId}/resend
• GET
  Inspect an outbound webhook delivery/v1/webhook-deliveries/{deliveryId}
• POST
  Replay a failed outbound webhook delivery/v1/webhook-deliveries/{deliveryId}/replay
• POST
  Redrive failed outbound webhook deliveries/v1/webhook-deliveries/redrive
• POST
  Apply a coupon to a customer, account, or subscription/v1/coupons/{couponId}/apply
• POST
  Terminate a coupon/v1/coupons/{couponId}/terminate
• GET
  List applied billing coupons/v1/applied-coupons
• GET
  Get one applied billing coupon/v1/applied-coupons/{appliedCouponId}
• POST
  Terminate one applied coupon/v1/applied-coupons/{appliedCouponId}/terminate
• POST
  Grant prepaid customer balance/v1/customers/{customerId}/balance/grant
• POST
  Grant prepaid customer balance from a captured payment/v1/customers/{customerId}/balance/grant-from-payment
• POST
  Expire prepaid customer balance/v1/customers/{customerId}/balance/expire
• POST
  Reverse a prepaid customer balance ledger entry/v1/customers/{customerId}/balance/reverse
• POST
  Preview an invoice/v1/invoices/preview
• POST
  Refresh a draft invoice/v1/invoices/{invoiceId}/refresh
• POST
  Quote tax for a draft invoice/v1/invoices/{invoiceId}/tax/quote
• GET
  Inspect invoice payment lifecycle/v1/invoices/{invoiceId}/payment-lifecycle
• GET
  List invoice payment receipts/v1/invoices/{invoiceId}/receipts
• GET
  Get one payment receipt artifact/v1/payment-receipts/{receiptId}
• GET
  Inspect billing and payments refund lineage for a credit note/v1/credit-notes/{creditNoteId}/refund-lineage
• POST
  Reconcile credit-note refund linkage after drift or provider replay/v1/credit-notes/{creditNoteId}/reconcile-refund