Beta Ramps API
Subaccounts

Post Subaccounts By Subaccount Id Onboarding Refresh Status

POST
/subaccounts/{subaccount_id}/onboarding/refresh-status

Authorization

headerAuthorizationBearer <token>

Scope: subaccounts:write

Path Parameters

subaccount_id*string

Response Body

Current onboarding status (optionally polled live from the provider).

application/json
  1. response
subaccount_id*string
external_provider_status*|

Raw provider status, or null if not yet provisioned.

Value in"pending_provisioning""pending_activation""active""failed""deprecated"null
onboarding_status*string

Derived onboarding state.

Value in"link_incomplete""pending_activation""active""failed"
has_external_provider_id*boolean
polled_bridge*boolean

True when this call polled the provider live.

Example Request
curl -X POST 'https://api.betaramps.com/subaccounts/string/onboarding/refresh-status'
Example Response
{  "subaccount_id": "sub_0192f4e3-8a9b-7c6d-5e4f-3a2b1c0d9e8f",  "external_provider_status": "active",  "onboarding_status": "active",  "has_external_provider_id": true,  "polled_bridge": true}