Delete Orchestration Rule

Deactivates an orchestration rule by updating its status to DELETED. Once deleted, the rule will no longer trigger new orchestrations. Any orchestrations previously created by the rule will continue to be processed.

The request accepts a single rule ID and returns the updated rule resource with its status set to DELETED upon success.

DELETE /orchestration/rules/{id}

Try it

Delete Orchestration Rule

cURL

curl --request DELETE \
  --url https://api.paxos.com/v2/orchestration/rules/{id} \
  --header 'Authorization: Bearer <token>'

200

{
  "rule": {
    "id": "<string>",
    "ref_id": "<string>",
    "nickname": "<string>",
    "profile_id": "<string>",
    "identity_id": "<string>",
    "account_id": "<string>",
    "status": "ACTIVE",
    "source_asset": "<string>",
    "destination_asset": "<string>",
    "source": {
      "crypto": {
        "address_id": "<string>",
        "address": "<string>",
        "network": "<string>"
      },
      "fiat": {
        "deposit_instructions_id": "<string>",
        "network": "<string>",
        "account_type": "<string>",
        "memo_id": "<string>"
      },
      "profile": {
        "profile_id": "<string>"
      }
    },
    "destination": {
      "crypto": {
        "address": "<string>",
        "network": "<string>"
      },
      "fiat": {
        "fiat_account_id": "<string>",
        "memo": "<string>"
      },
      "profile": {
        "profile_id": "<string>"
      }
    },
    "created_at": "2023-11-07T05:31:56Z"
  }
}

OAuth Scope

orchestration:write_orchestration_rule

Authorizations

Authorization · string · header · required

Paxos APIs use OAuth 2 with the client credentials grant flow.

Token URLs:

• Production: https://oauth.paxos.com/oauth2/token
• Sandbox: https://oauth.sandbox.paxos.com/oauth2/token

Learn more in the API credentials guide →

Path Parameters

id · string · required

The ID of the orchestration rule to delete

Response

200 - application/json

A successful response.

rule · object

Show child attributes

rule. id · string

Unique identifier for the orchestration rule.

rule. ref_id · string

Unique reference ID for the rule.

rule. nickname · string

Optional human-readable nickname for the rule.

rule. profile_id · string

Profile ID of the account owner.

rule. identity_id · string

Identity ID of the account owner.

rule. account_id · string

Account ID where the rule applies.

rule. status · enum<string>

• ACTIVE: The rule is active, deposits matching the source_asset and source of this rule start a conversion and subsequent delivery of the destination_asset to the specified destination.
• DELETED: The rule has been deleted, newly deposited source_assets to the source of this rule will not be converted. The deposited source_asset is still going to be credited to the Profile specified by profile_id.
• PENDING: The rule creation is pending approval(s) before the rule becomes ACTIVE.
• REJECTED: The rule creation has been rejected during the approval process.
• CANCELLED: The rule creation has been cancelled before it could be approved.

Available options: ACTIVE, DELETED, PENDING, REJECTED, CANCELLED

rule. source_asset · string

Asset being converted from.

rule. destination_asset · string

Asset being converted to.

rule. source · object

Show child attributes

rule.source. crypto · object

Show child attributes

rule.source.crypto. address_id · string

rule.source.crypto. address · string

rule.source.crypto. network · string

rule.source. fiat · object

Show child attributes

rule.source.fiat. deposit_instructions_id · string

rule.source.fiat. network · string

rule.source.fiat. account_type · string

rule.source.fiat. memo_id · string

rule.source. profile · object

Show child attributes

rule.source.profile. profile_id · string

rule. destination · object

Show child attributes

rule.destination. crypto · object

Show child attributes

rule.destination.crypto. address · string

rule.destination.crypto. network · string

rule.destination. fiat · object

Show child attributes

rule.destination.fiat. fiat_account_id · string

rule.destination.fiat. memo · string

rule.destination. profile · object

Show child attributes

rule.destination.profile. profile_id · string

rule. created_at · string<date-time>

Timestamp when the rule was created.