Sub-Platforms API
API reference
Sub-Platforms — API Reference
Base URL: https://api.goldrail.xyz (also https://api.openconnect.cc, where /connect/* = /api/connect/*).
Every route below also answers under the train alias /api/genesis/.... Generated from the Official Postman collection (goldrail-api/postman/official-sub-platforms.collection.json), itself built from the route inventory of the code. The Auth column gives the expected credential.
Guides: Sub-Platforms.
accounts
| Method | Path | Operation | Auth |
|---|---|---|---|
| POST | /api/connect/sub-platforms | Create Sub-Platform | API key |
| GET | /api/connect/sub-platforms?limit=50&offset=0 | List Sub-Platforms | API key |
| GET | /api/connect/sub-platforms/{subPlatformId} | Get Sub-Platform | API key |
| PATCH | /api/connect/sub-platforms/{subPlatformId} | Update Sub-Platform | API key |
| POST | /api/connect/sub-platforms/{subPlatformId}/provision | Provision | API key |
| POST | /api/connect/sub-platforms/{subPlatformId}/migrate | Migrate (upgrade) | API key |
| POST | /api/connect/sub-platforms/{subPlatformId}/api-keys/reveal | Reveal API key | API key |
| POST | /api/connect/sub-platforms/{subPlatformId}/api-keys/rotate | Rotate API key | API key |
| POST | /api/connect/sub-platforms/{subPlatformId}/transfer | Transfer to Sub-Platform | API key |
onboarding
| Method | Path | Operation | Auth |
|---|---|---|---|
| POST | /api/connect/sub-platforms/onboarding/accounts | Create account | API key |
| GET | /api/connect/sub-platforms/onboarding/accounts/{subPlatformId} | Get account | API key |
| POST | /api/connect/sub-platforms/onboarding/account-links | Create account link | API key |
| GET | /api/connect/sub-platforms/onboarding/verify?account_id={subPlatformId}&parent_id={fintechId}&expires={linkExpires}&sig={linkSig} | Verify | Public |
More endpoints (from code) / root
| Method | Path | Operation | Auth |
|---|---|---|---|
| GET | /api/connect/sub-platforms/{id}/customer-link | GET /api/connect/sub-platforms/:id/customer-link | API key |
| PATCH | /api/connect/sub-platforms/{id}/customer-link | PATCH /api/connect/sub-platforms/:id/customer-link | API key |
Customer link
POST /api/connect/sub-platforms takes an optional customer_link: { mode: "separate" | "both" | "replace", customer_id }
(customer_id required for both and replace). PATCH /api/connect/sub-platforms/:id/customer-link takes the same object and
returns { sub_platform_id, payments_module_id, mode, customer_id, customer_type, previous_customer_id }.
See Customer link.
The member portal routes (/api/openconnect/ocplatform/portal/*) are described in Same routes, your own key.
With a Sub-Platform key
A Sub-Platform has no routes under /api/connect/sub-platforms. With its key (oc_live_*) it calls
the product routes; the key decides the scope. See
Same routes, your own key.
| Method | Path | Operation | Auth |
|---|---|---|---|
| POST | /api/connect/treasury/payment-requests/core | Create payment request | Sub-Platform key |
| GET | /api/connect/treasury/payment-requests/core/{paymentRequestId} | Get payment request | Sub-Platform key |
| POST | /api/connect/treasury/payment-requests/core/{paymentRequestId}/cancel | Cancel payment request | Sub-Platform key |
| POST · GET | /api/connect/ramp/core/links | Create / list ramp links | Sub-Platform key |
| GET · PATCH · DELETE | /api/connect/ramp/core/links/{rampLinkId} | Get / update / delete ramp link | Sub-Platform key |
| GET | /api/connect/ramp/core/operations | List ramp operations | Sub-Platform key |
| POST | /api/connect/ramp/core/embed-token | Create embed token | Sub-Platform key |
| GET · PUT | /api/connect/ramp/settings | Get / update ramp settings | Sub-Platform key |
| GET · PATCH | /api/connect/commerce/payment-methods | Get / update portal payment methods | Sub-Platform key |
| GET · POST | /api/webhooks | List / create its webhooks | Sub-Platform key |
| GET | /api/openconnect/ocplatform/me | Me | Sub-Platform key |
| POST | /api/openconnect/ocplatform/api-keys/rotate | Rotate API key | Sub-Platform key |