Ctrl+K

Enable On-Chain Settlement Automation for OES Partner

patch/api/network/v1/admin/partners/settlements/onchain/enableautomation

Admin API to enable on-chain settlement automation for an OES partner.

Query Parameters

  • trustOrgstringRequired
    Trust organization identifier. Used for access control based on trust organization membership.
    Enum: BitGo Trust BitGo New York BitGo Germany BitGo Switzerland BitGo Europe ApS Frankfurt DE Trust BitGo Singapore BitGo Korea BitGo Custody MENA FZE BitGo India BitGo Sister Trust 1

Request Body

partnerId string required
The unique identifier of the partner for which to enable settlement automation. This is a UUID that uniquely identifies the partner organization.

200 Response

id string required
enterpriseId string required
Min length: >= 1 characters
trustOrg string required
Allowed values: BitGo Trust BitGo New York BitGo Germany BitGo Switzerland BitGo Europe ApS Frankfurt DE Trust BitGo Singapore BitGo Korea BitGo Custody MENA FZE BitGo India BitGo Sister Trust 1
institutionId string
institutionIdentifier string required
Min length: >= 1 characters
name string required
Min length: >= 1 characters
connectionKeySchema string required
Allowed values: token tokenAndSignature apiKeyAndSecret clearloop
createdAt string <date-time>required
Timestamp when the partner was created in the system.
updatedAt string <date-time>required
Timestamp of the most recent update to the partner record.
clientId string required
broker boolean required
active boolean required
settlementTransactionRouteId string
clientDisputeWindowMinutes number
topUpWindowMinutes number
allocationPoliciesEnabled boolean required
publicKey string
Optional RSA public key associated with the partner. This key is used for secure communication and encrypting connection keys. If not supplied, encryption is not required for the partner.

400 Response

403 Response

error string required

404 Response

error string required

422 Response

error string required

500 Response

error string required