# HashPay API docs

## API Docs
- Auth [Register a dashboard user and create their first organization.](https://docs.hashpay.me/register-a-dashboard-user-and-create-their-first-organization-41748653e0.md): 
- Auth [Authenticate a dashboard user.](https://docs.hashpay.me/authenticate-a-dashboard-user-41748654e0.md): 
- Auth [Rotate refresh token and issue a new access token.](https://docs.hashpay.me/rotate-refresh-token-and-issue-a-new-access-token-41748655e0.md): 
- Auth [Revoke a refresh token.](https://docs.hashpay.me/revoke-a-refresh-token-41748656e0.md): 
- Organizations [List organizations visible to the current user.](https://docs.hashpay.me/list-organizations-visible-to-the-current-user-41748657e0.md): 
- Organizations [Create an organization.](https://docs.hashpay.me/create-an-organization-41748658e0.md): 
- Organizations [Get organization details.](https://docs.hashpay.me/get-organization-details-41748659e0.md): 
- Organizations [Update organization profile and KYB fields.](https://docs.hashpay.me/update-organization-profile-and-kyb-fields-41748660e0.md): 
- Organizations [Submit organization KYB for admin review.](https://docs.hashpay.me/submit-organization-kyb-for-admin-review-41748661e0.md): 
- Users [List organization members.](https://docs.hashpay.me/list-organization-members-41748662e0.md): 
- API Keys [List API keys.](https://docs.hashpay.me/list-api-keys-41748663e0.md): 
- API Keys [Create an API key and return the secret once.](https://docs.hashpay.me/create-an-api-key-and-return-the-secret-once-41748664e0.md): 
- API Keys [Revoke an API key.](https://docs.hashpay.me/revoke-an-api-key-41748665e0.md): 
- Customers [List customers.](https://docs.hashpay.me/list-customers-41748666e0.md): 
- Customers [Create a customer.](https://docs.hashpay.me/create-a-customer-41748667e0.md): 
- Customers [Update a customer.](https://docs.hashpay.me/update-a-customer-41748668e0.md): 
- Wallets [List receiving wallets.](https://docs.hashpay.me/list-receiving-wallets-41748669e0.md): 
- Wallets [Register a public receiving wallet.](https://docs.hashpay.me/register-a-public-receiving-wallet-41748670e0.md): 
- Wallets [Archive a receiving wallet.](https://docs.hashpay.me/archive-a-receiving-wallet-41748671e0.md): 
- Invoices [List invoices.](https://docs.hashpay.me/list-invoices-41748672e0.md): 
- Invoices [Create an invoice.](https://docs.hashpay.me/create-an-invoice-41748673e0.md): 
- Invoices [Get an invoice.](https://docs.hashpay.me/get-an-invoice-41748674e0.md): 
- Invoices [Update draft invoice fields.](https://docs.hashpay.me/update-draft-invoice-fields-41748675e0.md): 
- Invoices [Cancel an invoice.](https://docs.hashpay.me/cancel-an-invoice-41748676e0.md): 
- Checkout [Get public checkout session.](https://docs.hashpay.me/get-public-checkout-session-41748677e0.md): 
- Checkout [Submit transaction hash manually.](https://docs.hashpay.me/submit-transaction-hash-manually-41748678e0.md): 
- Payments [List invoice payment allocations.](https://docs.hashpay.me/list-invoice-payment-allocations-41748679e0.md): 
- Webhooks [List webhook endpoints.](https://docs.hashpay.me/list-webhook-endpoints-41748680e0.md): 
- Webhooks [Create webhook endpoint.](https://docs.hashpay.me/create-webhook-endpoint-41748681e0.md): 
- Webhooks [Update webhook endpoint.](https://docs.hashpay.me/update-webhook-endpoint-41748682e0.md): 
- Webhooks [Disable webhook endpoint.](https://docs.hashpay.me/disable-webhook-endpoint-41748683e0.md): 
- Webhooks [List webhook deliveries.](https://docs.hashpay.me/list-webhook-deliveries-41748684e0.md): 
- Webhooks [Replay a webhook delivery.](https://docs.hashpay.me/replay-a-webhook-delivery-41748685e0.md): 
- Usage [Get current usage summary.](https://docs.hashpay.me/get-current-usage-summary-41748686e0.md): 
- Billing [List available subscription plans.](https://docs.hashpay.me/list-available-subscription-plans-41748687e0.md): 
- Billing [Get active subscription.](https://docs.hashpay.me/get-active-subscription-41748688e0.md): Returns the organization's subscription, or `null` when the caller is a platform admin and the organization has not selected a plan yet.
- Billing [Schedule a subscription plan change at period end.](https://docs.hashpay.me/schedule-a-subscription-plan-change-at-period-end-41748689e0.md): 
- Billing [Select a subscription plan and start a trial.](https://docs.hashpay.me/select-a-subscription-plan-and-start-a-trial-41748690e0.md): 
- Billing [List HashPay platform invoices.](https://docs.hashpay.me/list-hashpay-platform-invoices-41748691e0.md): 
- Billing [Get a HashPay platform invoice.](https://docs.hashpay.me/get-a-hashpay-platform-invoice-41748692e0.md): 
- Analytics [Get merchant analytics summary.](https://docs.hashpay.me/get-merchant-analytics-summary-41748693e0.md): 
- Analytics [Get merchant analytics chart data.](https://docs.hashpay.me/get-merchant-analytics-chart-data-41748694e0.md): 
- Analytics [Get top customers by payment volume.](https://docs.hashpay.me/get-top-customers-by-payment-volume-41748695e0.md): 
- Analytics [Get top wallets by payment volume.](https://docs.hashpay.me/get-top-wallets-by-payment-volume-41748696e0.md): 
- Audit Logs [List audit logs.](https://docs.hashpay.me/list-audit-logs-41748697e0.md): 
- Admin [List organizations for admin review.](https://docs.hashpay.me/list-organizations-for-admin-review-41748698e0.md): 
- Admin [Get organization detail for admin review.](https://docs.hashpay.me/get-organization-detail-for-admin-review-41748699e0.md): 
- Admin [Approve, reject, or request changes for merchant verification.](https://docs.hashpay.me/approve-reject-or-request-changes-for-merchant-verification-41748700e0.md): 
- Admin [Get platform analytics summary for the admin overview.](https://docs.hashpay.me/get-platform-analytics-summary-for-the-admin-overview-41748701e0.md): 
- Admin [Get platform analytics charts for the admin overview.](https://docs.hashpay.me/get-platform-analytics-charts-for-the-admin-overview-41748702e0.md): 
- Admin [Get top merchants by processed volume for a period.](https://docs.hashpay.me/get-top-merchants-by-processed-volume-for-a-period-41748703e0.md): 
- Admin [List invoice payments across organizations for investigation.](https://docs.hashpay.me/list-invoice-payments-across-organizations-for-investigation-41748704e0.md): 
- Admin [List audit logs across organizations.](https://docs.hashpay.me/list-audit-logs-across-organizations-41748705e0.md): 
- Admin [Get platform billing receive-wallet configuration.](https://docs.hashpay.me/get-platform-billing-receive-wallet-configuration-41748706e0.md): 
- Admin [Assign the platform billing receive wallet.](https://docs.hashpay.me/assign-the-platform-billing-receive-wallet-41748707e0.md): 
- Admin [List wallets belonging to the platform organization.](https://docs.hashpay.me/list-wallets-belonging-to-the-platform-organization-41748708e0.md): 
- Admin [List platform invoices across organizations.](https://docs.hashpay.me/list-platform-invoices-across-organizations-41748709e0.md): 
- Admin [Get platform invoice detail with line items.](https://docs.hashpay.me/get-platform-invoice-detail-with-line-items-41748710e0.md): 
- Admin [List credits for an organization.](https://docs.hashpay.me/list-credits-for-an-organization-41748711e0.md): 
- Admin [Apply a billing credit to an organization.](https://docs.hashpay.me/apply-a-billing-credit-to-an-organization-41748712e0.md): 
- Admin [List discounts for an organization.](https://docs.hashpay.me/list-discounts-for-an-organization-41748713e0.md): 
- Admin [Apply a billing discount to an organization.](https://docs.hashpay.me/apply-a-billing-discount-to-an-organization-41748714e0.md): 
- Admin [List manual billing adjustments for an organization.](https://docs.hashpay.me/list-manual-billing-adjustments-for-an-organization-41748715e0.md): 
- Admin [Create a manual billing adjustment for an organization.](https://docs.hashpay.me/create-a-manual-billing-adjustment-for-an-organization-41748716e0.md): 
- Admin [Get platform operations status for the admin operations view.](https://docs.hashpay.me/get-platform-operations-status-for-the-admin-operations-view-41748717e0.md): 
- Admin [List webhook deliveries across organizations.](https://docs.hashpay.me/list-webhook-deliveries-across-organizations-41748718e0.md): 
- Admin [List recent failed jobs for a BullMQ queue (read-only).](https://docs.hashpay.me/list-recent-failed-jobs-for-a-bullmq-queue-read-only-41748719e0.md): 

## Schemas
- [LoginRequest](https://docs.hashpay.me/loginrequest-17036063d0.md): 
- [RegisterRequest](https://docs.hashpay.me/registerrequest-17036064d0.md): 
- [AuthSession](https://docs.hashpay.me/authsession-17036065d0.md): 
- [RefreshSessionRequest](https://docs.hashpay.me/refreshsessionrequest-17036066d0.md): 
- [LogoutRequest](https://docs.hashpay.me/logoutrequest-17036067d0.md): 
- [Organization](https://docs.hashpay.me/organization-17036068d0.md): 
- [OrganizationList](https://docs.hashpay.me/organizationlist-17036069d0.md): 
- [AdminOrganization](https://docs.hashpay.me/adminorganization-17036070d0.md): 
- [AdminReviewHistoryItem](https://docs.hashpay.me/adminreviewhistoryitem-17036071d0.md): 
- [AdminOrganizationDetail](https://docs.hashpay.me/adminorganizationdetail-17036072d0.md): 
- [AdminOrganizationList](https://docs.hashpay.me/adminorganizationlist-17036073d0.md): 
- [UpdateOrganizationVerificationRequest](https://docs.hashpay.me/updateorganizationverificationrequest-17036074d0.md): 
- [MembershipList](https://docs.hashpay.me/membershiplist-17036075d0.md): 
- [ApiKeyList](https://docs.hashpay.me/apikeylist-17036076d0.md): 
- [ApiKey](https://docs.hashpay.me/apikey-17036077d0.md): 
- [CreatedApiKey](https://docs.hashpay.me/createdapikey-17036078d0.md): 
- [Customer](https://docs.hashpay.me/customer-17036079d0.md): 
- [CustomerList](https://docs.hashpay.me/customerlist-17036080d0.md): 
- [Wallet](https://docs.hashpay.me/wallet-17036081d0.md): 
- [WalletList](https://docs.hashpay.me/walletlist-17036082d0.md): 
- [CreateInvoiceRequest](https://docs.hashpay.me/createinvoicerequest-17036083d0.md): 
- [Invoice](https://docs.hashpay.me/invoice-17036084d0.md): 
- [InvoiceStatus](https://docs.hashpay.me/invoicestatus-17036085d0.md): 
- [InvoiceList](https://docs.hashpay.me/invoicelist-17036086d0.md): 
- [CheckoutSession](https://docs.hashpay.me/checkoutsession-17036087d0.md): 
- [PaymentList](https://docs.hashpay.me/paymentlist-17036088d0.md): 
- [WebhookEndpoint](https://docs.hashpay.me/webhookendpoint-17036089d0.md): 
- [CreatedWebhookEndpoint](https://docs.hashpay.me/createdwebhookendpoint-17036090d0.md): 
- [CreateWebhookEndpointRequest](https://docs.hashpay.me/createwebhookendpointrequest-17036091d0.md): 
- [UpdateWebhookEndpointRequest](https://docs.hashpay.me/updatewebhookendpointrequest-17036092d0.md): 
- [WebhookEndpointList](https://docs.hashpay.me/webhookendpointlist-17036093d0.md): 
- [WebhookDelivery](https://docs.hashpay.me/webhookdelivery-17036094d0.md): 
- [WebhookDeliveryList](https://docs.hashpay.me/webhookdeliverylist-17036095d0.md): 
- [UsageSummary](https://docs.hashpay.me/usagesummary-17036096d0.md): 
- [Subscription](https://docs.hashpay.me/subscription-17036097d0.md): 
- [SubscriptionOpenInvoice](https://docs.hashpay.me/subscriptionopeninvoice-17036098d0.md): 
- [ChangePlanRequest](https://docs.hashpay.me/changeplanrequest-17036099d0.md): 
- [SelectPlanRequest](https://docs.hashpay.me/selectplanrequest-17036100d0.md): 
- [PlanCatalog](https://docs.hashpay.me/plancatalog-17036101d0.md): 
- [Plan](https://docs.hashpay.me/plan-17036102d0.md): 
- [PlatformInvoice](https://docs.hashpay.me/platforminvoice-17036103d0.md): 
- [PlatformInvoiceList](https://docs.hashpay.me/platforminvoicelist-17036104d0.md): 
- [AdminPlatformInvoice](https://docs.hashpay.me/adminplatforminvoice-17036105d0.md): 
- [AdminPlatformInvoiceLine](https://docs.hashpay.me/adminplatforminvoiceline-17036106d0.md): 
- [AdminPlatformInvoiceDetail](https://docs.hashpay.me/adminplatforminvoicedetail-17036107d0.md): 
- [AdminPlatformInvoiceList](https://docs.hashpay.me/adminplatforminvoicelist-17036108d0.md): 
- [ApplyAdminCreditRequest](https://docs.hashpay.me/applyadmincreditrequest-17036109d0.md): 
- [AdminCredit](https://docs.hashpay.me/admincredit-17036110d0.md): 
- [AdminCreditList](https://docs.hashpay.me/admincreditlist-17036111d0.md): 
- [ApplyAdminDiscountRequest](https://docs.hashpay.me/applyadmindiscountrequest-17036112d0.md): 
- [AdminDiscount](https://docs.hashpay.me/admindiscount-17036113d0.md): 
- [AdminDiscountList](https://docs.hashpay.me/admindiscountlist-17036114d0.md): 
- [CreateAdminManualAdjustmentRequest](https://docs.hashpay.me/createadminmanualadjustmentrequest-17036115d0.md): 
- [AdminManualAdjustment](https://docs.hashpay.me/adminmanualadjustment-17036116d0.md): 
- [AdminManualAdjustmentList](https://docs.hashpay.me/adminmanualadjustmentlist-17036117d0.md): 
- [AnalyticsSummary](https://docs.hashpay.me/analyticssummary-17036118d0.md): 
- [MerchantAnalyticsSummary](https://docs.hashpay.me/merchantanalyticssummary-17036119d0.md): 
- [MerchantAnalyticsCharts](https://docs.hashpay.me/merchantanalyticscharts-17036120d0.md): 
- [MerchantVolumeSeriesPoint](https://docs.hashpay.me/merchantvolumeseriespoint-17036121d0.md): 
- [MerchantInvoiceStatusBreakdownItem](https://docs.hashpay.me/merchantinvoicestatusbreakdownitem-17036122d0.md): 
- [TopCustomerList](https://docs.hashpay.me/topcustomerlist-17036123d0.md): 
- [TopWalletList](https://docs.hashpay.me/topwalletlist-17036124d0.md): 
- [TopCustomer](https://docs.hashpay.me/topcustomer-17036125d0.md): 
- [TopWallet](https://docs.hashpay.me/topwallet-17036126d0.md): 
- [TopOrganizationList](https://docs.hashpay.me/toporganizationlist-17036127d0.md): 
- [TopOrganization](https://docs.hashpay.me/toporganization-17036128d0.md): 
- [AdminPaymentList](https://docs.hashpay.me/adminpaymentlist-17036129d0.md): 
- [AdminPayment](https://docs.hashpay.me/adminpayment-17036130d0.md): 
- [AdminWebhookDeliveryList](https://docs.hashpay.me/adminwebhookdeliverylist-17036131d0.md): 
- [AdminWebhookDelivery](https://docs.hashpay.me/adminwebhookdelivery-17036132d0.md): 
- [AdminFailedQueueJobList](https://docs.hashpay.me/adminfailedqueuejoblist-17036133d0.md): 
- [AdminFailedQueueJob](https://docs.hashpay.me/adminfailedqueuejob-17036134d0.md): 
- [PlatformAnalyticsSummary](https://docs.hashpay.me/platformanalyticssummary-17036135d0.md): 
- [PlatformAnalyticsCharts](https://docs.hashpay.me/platformanalyticscharts-17036136d0.md): 
- [AdminOperationsStatus](https://docs.hashpay.me/adminoperationsstatus-17036137d0.md): 
- [OperationsProviderHealth](https://docs.hashpay.me/operationsproviderhealth-17036138d0.md): 
- [OperationsQueueDepth](https://docs.hashpay.me/operationsqueuedepth-17036139d0.md): 
- [OperationsWebhookBacklog](https://docs.hashpay.me/operationswebhookbacklog-17036140d0.md): 
- [AuditLogList](https://docs.hashpay.me/auditloglist-17036141d0.md): 
- [AuditLog](https://docs.hashpay.me/auditlog-17036142d0.md):