Sandbox Testing
Test onboarding end to end in the sandbox: the base URL, test identities, and how to drive a business to active or a KYB rejection.
Test the full onboarding flow in the sandbox before you go live. The sandbox behaves like production but uses test credentials and test identities, so you can create a business, complete its requirements, and drive it to a terminal outcome without touching live data.
Sandbox base URL
Every sandbox call uses the sandbox host and your sandbox x-api-key:
curl https://sandbox-api.prioritycommerce.com/v1/businesses \
-H "x-api-key: <your-sandbox-key>"The production host (https://api.prioritycommerce.com) is used only after your integration is approved. See Getting Started for access and Go live for the switch to production.
Test data
Use these test values to exercise each outcome. Retrieve the business after each step to read its status and any missingFields / missingDocuments.
| Scenario | Test data | Expected result |
|---|---|---|
| Create a business | A minimal POST /v1/businesses (legal name only) | 201 Created, no status yet |
| Complete for underwriting | A complete LLC payload (owners, bank account, address, location, service) | Service status: PENDING_UNDERWRITING |
| Drive to active | Complete the requirements, then submit | Service status: ACTIVE |
| KYB rejection | A businessType whose ownership totals break its rule | Submit-time validation error; no business created |
Duplicate externalId | Reuse an externalId on a different payload | 409 Conflict (Duplicate externalId provided) |
PENDING-PUBLISHThe exact sandbox test identities (test SSN/EIN, test routing numbers) and the specific trigger values that drive a sandbox business to
ACTIVEversus a KYB rejection are pending the boarding sandbox guide. Confirm the values and wait times against the sandbox before publish.
Drive a business to active
- Create the business and add its owners, bank account, address, and at least one location. See Create a business.
- Enable Accept Payments with
PATCH /v1/businesses/{businessId}/services. See Configure services. - Read the business back with
?expand=trueand confirmmissingFieldsandmissingDocumentsare empty. - Once requirements are complete, the service moves to
PENDING_UNDERWRITING, then toACTIVEon approval. Re-read the business to follow the change; there are no status webhooks.
Drive a KYB rejection
Send a payload that breaks a KYB rule for its businessType (for example a partnership whose owners total under 50%, or a business with zero control persons). The create returns a submit-time validation error and no business is created. The exact messages are on API Error Handling; the rules behind them are on Business validation & KYB rules.
See also
- Getting Started: access, what onboarding supports, and your first call
- Go live: move from sandbox to production
- Status lifecycle: how a business advances to
ACTIVE - API Error Handling: the validation and KYB messages you'll test against
Updated about 10 hours ago