- Auth
- Organizations
- Users
- API Keys
- Customers
- Wallets
- Invoices
- Checkout
- Payments
- Webhooks
- Usage
- Billing
- Analytics
- Audit Logs
- Admin
- List organizations for admin review.
- Get organization detail for admin review.
- Approve, reject, or request changes for merchant verification.
- Get platform analytics summary for the admin overview.
- Get platform analytics charts for the admin overview.
- Get top merchants by processed volume for a period.
- List invoice payments across organizations for investigation.
- List audit logs across organizations.
- Get platform billing receive-wallet configuration.
- Assign the platform billing receive wallet.
- List wallets belonging to the platform organization.
- List platform invoices across organizations.
- Get platform invoice detail with line items.
- List credits for an organization.
- Apply a billing credit to an organization.
- List discounts for an organization.
- Apply a billing discount to an organization.
- List manual billing adjustments for an organization.
- Create a manual billing adjustment for an organization.
- Get platform operations status for the admin operations view.
- List webhook deliveries across organizations.
- List recent failed jobs for a BullMQ queue (read-only).
- Schemas
- LoginRequest
- RegisterRequest
- AuthSession
- RefreshSessionRequest
- LogoutRequest
- Organization
- OrganizationList
- AdminOrganization
- AdminReviewHistoryItem
- AdminOrganizationDetail
- AdminOrganizationList
- UpdateOrganizationVerificationRequest
- MembershipList
- ApiKeyList
- ApiKey
- CreatedApiKey
- Customer
- CustomerList
- Wallet
- WalletList
- CreateInvoiceRequest
- Invoice
- InvoiceStatus
- InvoiceList
- CheckoutSession
- PaymentList
- WebhookEndpoint
- CreatedWebhookEndpoint
- CreateWebhookEndpointRequest
- UpdateWebhookEndpointRequest
- WebhookEndpointList
- WebhookDelivery
- WebhookDeliveryList
- UsageSummary
- Subscription
- SubscriptionOpenInvoice
- ChangePlanRequest
- SelectPlanRequest
- PlanCatalog
- Plan
- PlatformInvoice
- PlatformInvoiceList
- AdminPlatformInvoice
- AdminPlatformInvoiceLine
- AdminPlatformInvoiceDetail
- AdminPlatformInvoiceList
- ApplyAdminCreditRequest
- AdminCredit
- AdminCreditList
- ApplyAdminDiscountRequest
- AdminDiscount
- AdminDiscountList
- CreateAdminManualAdjustmentRequest
- AdminManualAdjustment
- AdminManualAdjustmentList
- AnalyticsSummary
- MerchantAnalyticsSummary
- MerchantAnalyticsCharts
- MerchantVolumeSeriesPoint
- MerchantInvoiceStatusBreakdownItem
- TopCustomerList
- TopWalletList
- TopCustomer
- TopWallet
- TopOrganizationList
- TopOrganization
- AdminPaymentList
- AdminPayment
- AdminWebhookDeliveryList
- AdminWebhookDelivery
- AdminFailedQueueJobList
- AdminFailedQueueJob
- PlatformAnalyticsSummary
- PlatformAnalyticsCharts
- AdminOperationsStatus
- OperationsProviderHealth
- OperationsQueueDepth
- OperationsWebhookBacklog
- AuditLogList
- AuditLog
Create an API key and return the secret once.
POST
/organizations/{organizationId}/api-keys
Request
Authorization
JWT Bearer
Add the parameter
Authorization
to HeadersExample:
Authorization: ********************or
API Key
Add parameter in header
X-HashPay-Key
Example:
X-HashPay-Key: ********************or
Path Params
Responses
🟢201
application/json
Bodyapplication/json
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.hashpay.me/v1/organizations//api-keys' \
--header 'Authorization: Bearer <token>'Response Response Example
{
"id": "string",
"name": "string",
"prefix": "string",
"scopes": [
"string"
],
"status": "active",
"expiresAt": "2019-08-24T14:15:22.123Z",
"lastUsedAt": "2019-08-24T14:15:22.123Z",
"secret": "string"
}Modified at 2026-08-13 12:54:46