Skip to main content
POST
/
v2
/
orchestration
/
orchestration-rules
{
  "rule": {
    "id": "<string>",
    "ref_id": "<string>",
    "nickname": "<string>",
    "profile_id": "<string>",
    "identity_id": "<string>",
    "account_id": "<string>",
    "status": "PROCESSING",
    "source_asset": "<string>",
    "destination_asset": "<string>",
    "source_deposit_instructions": {
      "crypto": {
        "address_id": "<string>",
        "address": "<string>",
        "network": "<string>"
      },
      "fiat": {
        "id": "<string>",
        "bank_name": "<string>",
        "bank_country": "<string>",
        "bank_address": "<string>",
        "routing_number_type": "ABA",
        "routing_number": "<string>",
        "recipient_name": "<string>",
        "recipient_address": "<string>",
        "account_number": "<string>"
      }
    },
    "destination": {
      "crypto": {
        "address": "<string>",
        "network": "<string>"
      },
      "fiat": {
        "account_id": "<string>",
        "memo": "<string>",
        "network": "<string>"
      },
      "profile": {
        "profile_id": "<string>"
      }
    },
    "created_at": "2023-11-07T05:31:56Z",
    "deleted_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json
​
ref_id
string
​
nickname
string
​
profile_id
string
​
identity_id
string
​
account_id
string
​
source_asset
string
​
destination_asset
string
​
source
object

The source resource of an orchestration rule. Deposits to this resource will trigger invocations of the rule. Each invocation will create an "Orchestration".

​
destination
object

A request to send funds to a destination resource at the end of an orchestrated conversion flow.

​
metadata
object

Response

A successful response.

​
rule
object