Skip to main content
POST
refreshCompanyBankAccountStatus

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json
method
string
default:refreshCompanyBankAccountStatus
required
companyId
string<uuid>
required

The ID of the sandbox company.

Response

200 - application/json

The current bank account result or an error response. Check the response body rather than relying on the HTTP status alone.

success
boolean
bankAccountStatus
string

A ready or active status indicates that at least one active company funding source is approved. May be empty if no status is available.

message
string
error