Product API
Every call the saved Build admits, with a request to copy.
Every Hyperscale operation is one HTTP call under /v1. Send an API key as a bearer token and name the environment in the X-Hyperscale-Environment header: sandbox or live.
The platform reference below lists each operation with its method, path and input. Signed in, this page also lists the calls your own product's saved Build admits, with a request sample to copy.
Platform operations
| Operation | HTTP |
|---|---|
Retrieve an account balance account.balance.retrieve | GET /v1/accounts/{accountId}/balance |
Close an account account.close | POST /v1/accounts/{accountId}/close |
Create an account account.create | POST /v1/accounts |
Deposit money into an account through a bank adapter account.deposit | POST /v1/account-deposits |
Freeze an account account.freeze | POST /v1/accounts/{accountId}/freeze |
List account reservations account.hold.list | GET /v1/accounts/{accountId}/holds |
Retrieve an account reservation account.hold.retrieve | GET /v1/accounts/{accountId}/holds/{transferId} |
List Accounts account.list | GET /v1/accounts |
Retrieve an Account account.retrieve | GET /v1/accounts/{accountId} |
Export a monthly account statement account.statement.export | GET /v1/accounts/{accountId}/statements/{period}/export |
Retrieve a monthly account statement account.statement.retrieve | GET /v1/accounts/{accountId}/statements/{period} |
Unfreeze an account account.unfreeze | POST /v1/accounts/{accountId}/unfreeze |
List company activity activity.list | GET /v1/activity |
Retrieve one company activity event activity.retrieve | GET /v1/activity/{activityId} |
List Audit events audit_event.list | GET /v1/audit-events |
Retrieve an Audit event audit_event.retrieve | GET /v1/audit-events/{auditEventId} |
List Consents consent.list | GET /v1/consents |
Retrieve a Consent consent.retrieve | GET /v1/consents/{consentId} |
Revoke provider data consent consent.revoke | POST /v1/consents/{consentId}/revoke |
Close customer access customer_access.close | POST /v1/customer-access/{customerAccessId}/close |
List Customer accesses customer_access.list | GET /v1/customer-access |
Reactivate customer access customer_access.reactivate | POST /v1/customer-access/{customerAccessId}/reactivate |
Retrieve a Customer access customer_access.retrieve | GET /v1/customer-access/{customerAccessId} |
Suspend customer access customer_access.suspend | POST /v1/customer-access/{customerAccessId}/suspend |
Log out the current end-customer session customer_logout | MCP only |
Read the signed-in end customer's balance and activity customer_me_retrieve | MCP only |
Revoke one of the calling end customer's sessions customer_session_revoke | MCP only |
Create a customer customer.create | POST /v1/customers |
List Customers customer.list | GET /v1/customers |
Update a customer legal profile customer.profile.update | PATCH /v1/customers/{customerId}/profile |
Retrieve a Customer customer.retrieve | GET /v1/customers/{customerId} |
List developer logs developer.log.list | GET /v1/developer-logs |
Retrieve a developer log developer.log.retrieve | GET /v1/developer-logs/{operationId} |
List events event.list | GET /v1/events |
Retrieve an event event.retrieve | GET /v1/events/{eventId} |
List catalog extensions extension.list | GET /v1/extensions |
List Internal Transfers internal_transfer.list | GET /v1/internal-transfers |
Retrieve an Internal Transfer internal_transfer.retrieve | GET /v1/internal-transfers/{transferId} |
List Operations operation.list | GET /v1/operations |
Retrieve an Operation operation.retrieve | GET /v1/operations/{operationId} |
Read payment reminder delivery evidence payment_reminder.delivery.retrieve | GET /v1/products/{productId}/payment-reminders/{operationId} |
List public actions, typed inputs and execution routes from the admitted Build product.actions.list | GET /v1/products/{productId}/actions |
Retrieve product activation readiness and cost product.activation.retrieve | GET /v1/products/{productId}/activation |
Summarize standard blocks product.blocks.summary | GET /v1/products/{productId}/blocks/summary |
Retrieve a Product's books product.books.retrieve | GET /v1/products/{productId}/books |
Retrieve product connections product.connections.retrieve | GET /v1/products/{productId}/connections |
List product earn rates product.earn.rate.list | GET /v1/products/{productId}/earn-rates |
Settle product earnings product.earnings.settle | POST /v1/products/{productId}/earnings/settlements |
Read a Product economic revision and confirmed balances product.economic_snapshot.retrieve | GET /v1/products/{productId}/economic-snapshot |
Retrieve deterministic product guidance product.guidance.retrieve | GET /v1/products/{productId}/guidance |
List the admitted Product instruments and typed fields product.instruments.list | GET /v1/products/{productId}/instruments |
List your Products product.list | GET /v1/products |
Retrieve the product margin view product.margin.retrieve | GET /v1/products/{productId}/margin |
List available actions and required metadata for an object product.objects.actions | GET /v1/products/{productId}/objects/{kind}/{objectId}/actions |
Read accepted action evidence for an object's agreement product.objects.agreements.evidence.list | GET /v1/products/{productId}/objects/{kind}/{objectId}/agreements/{instanceId}/evidence |
Read every agreement attached to an object product.objects.agreements.list | GET /v1/products/{productId}/objects/{kind}/{objectId}/agreements |
Create an object with optional metadata and no financial agreement product.objects.create | POST /v1/products/{productId}/objects/{kind} |
Discover business object kinds, authored fields, and attached actions product.objects.discover | GET /v1/products/{productId}/objects |
Execute an attached action with session-bound parties and required metadata product.objects.execute | POST /v1/products/{productId}/objects/{kind}/{objectId}/actions/{action} |
List business objects of a kind product.objects.list | GET /v1/products/{productId}/objects/{kind} |
Review an action without changing the record or moving money product.objects.preview | POST /v1/products/{productId}/objects/{kind}/{objectId}/actions/{action}/preview |
Retrieve a business object by ID product.objects.retrieve | GET /v1/products/{productId}/objects/{kind}/{objectId} |
Read what happened to an object product.objects.timeline.list | GET /v1/products/{productId}/objects/{kind}/{objectId}/timeline |
Retrieve a product's frozen operation set product.operation_set.retrieve | GET /v1/products/{productId}/operation-set |
Retrieve a Product product.retrieve | GET /v1/products/{productId} |
Read the schedule for one product product.schedule.list | GET /v1/products/{productId}/schedule |
Retrieve product treasury balances product.treasury.retrieve | GET /v1/products/{productId}/treasury |
Read work for one product product.work.list | GET /v1/products/{productId}/work |
List Receipts receipt.list | GET /v1/receipts |
Retrieve a Receipt receipt.retrieve | GET /v1/receipts/{receiptId} |
Refund a payment refund.create | POST /v1/refunds |
Fund a sandbox account sandbox.account.fund | POST /v1/sandbox/account-funding |
Advance the sandbox Product clock sandbox.clock.advance | POST /v1/sandbox/clock/advance |
Read the sandbox Product clock sandbox.clock.retrieve | GET /v1/products/{productId}/sandbox-clock |
Activate sandbox customer access sandbox.customer_access.activate | POST /v1/sandbox/customer-access/{customerAccessId}/activate |
Run a Product platform action in sandbox sandbox.platform.fire | POST /v1/sandbox/platform/fire |
Initiate a transfer return transfer_return.create | POST /v1/transfer-returns |
List Usage records usage_record.list | GET /v1/usage-records |
Retrieve a Usage record usage_record.retrieve | GET /v1/usage-records/{usageRecordId} |
Retrieve the company usage statement usage.statement | GET /v1/usage/statement |
List webhook deliveries webhook.delivery.list | GET /v1/webhook-endpoints/{webhookEndpointId}/deliveries |
Resend a webhook delivery webhook.delivery.resend | POST /v1/webhook-endpoints/{webhookEndpointId}/deliveries/{webhookDeliveryId}/resend |
Create a webhook endpoint webhook.endpoint.create | POST /v1/webhook-endpoints |
Delete a webhook endpoint webhook.endpoint.delete | POST /v1/webhook-endpoints/{webhookEndpointId}/delete |
Disable a webhook endpoint webhook.endpoint.disable | POST /v1/webhook-endpoints/{webhookEndpointId}/disable |
Enable a webhook endpoint webhook.endpoint.enable | POST /v1/webhook-endpoints/{webhookEndpointId}/enable |
List webhook endpoints webhook.endpoint.list | GET /v1/webhook-endpoints |
Recover webhook deliveries webhook.endpoint.recover | POST /v1/webhook-endpoints/{webhookEndpointId}/recover |
Retrieve a webhook endpoint webhook.endpoint.retrieve | GET /v1/webhook-endpoints/{webhookEndpointId} |
Update a webhook endpoint webhook.endpoint.update | PATCH /v1/webhook-endpoints/{webhookEndpointId} |
List webhook events for the current Product Build webhook.event.catalog | GET /v1/products/{productId}/webhook-event-catalog |