v1

latestOpenAPI 3.1.0Proprietary2026-07-2464170247.4 KB

Auto-Conversion Rules

Get Auto-Conversion Rule by Idempotency Key

Look up an Auto-Conversion Rule using the idempotency key provided during creation.

Use Case: Verify if an Auto-Conversion Rule was successfully created when network issues or timeouts occurred during the create request.

Status & Deposit Info:

PENDING: Deposit info is being prepared. source_deposit_info will be null.
ACTIVE: Deposit info is ready. source_deposit_info contains bank Wire/SWIFT details for fiat source, or wallet address for crypto source.

get/v1/customers/{customer_id}/auto-conversion-rules

Path parameters

customer_idstring required

Customer ID (UUID format)

Query parameters

idempotency_keystring required

HTTP Idempotency-Key header value. Stricter than other IDs: ≤64 ASCII chars per the common REST API convention.

The idempotency key used during resource creation. Used to safely retrieve or check the status of a resource after creation, especially useful for handling network failures or timeout scenarios.

Response

Successfully retrieved Auto-Conversion Rule

customer_idstring required

Portfolio ID — also exposed as customer_id in OpenAPI. Identifies one individual application / portfolio row within an entity.

account_idstring nullable

External account identifier of the owning customer

auto_conversion_rule_idstring required

Unique Auto-Conversion Rule identifier (UUID)

idempotency_keystring required

HTTP Idempotency-Key header value. Stricter than other IDs: ≤64 ASCII chars per the common REST API convention.

nicknamestring required

Auto-generated nickname based on source/destination

status'Pending' | 'Active' | 'Inactive' | 'Failed' required

Instruction Status - defines the lifecycle state of an instruction

deposit_info_statusstring

Status of source deposit info: PENDING (not yet active), ACTIVE (available), INACTIVE (temporarily unavailable)

created_atstring required

Auto-Conversion Rule creation timestamp (ISO 8601)

modified_atstring required

Last modification timestamp (ISO 8601)

Example response

{
  "customer_id": "14f20ebd-893b-11f0-b308-2eaa4f6974f2",
  "account_id": "BZ-A2C4-9XPN",
  "auto_conversion_rule_id": "e9ece207-8fd6-400e-872b-409701e57b74",
  "nickname": "My USD to USDC Rule",
  "source": {
    "asset": "USDC",
    "network": "ETHEREUM"
  },
  "destination": {
    "asset": "USDC",
    "network": "ETHEREUM",
    "wallet_address": "0x71a6c6be0be5f28ef4ea7541749d90d9c66fec7d",
    "external_account_id": "381b013e-8893-11f0-b308-2eaa4f6974f2"
  },
  "deposit_info_status": "ACTIVE",
  "source_deposit_info": {
    "network": "wire",
    "reference_code": "25BO475M7V",
    "recipient_name": "1Money Company, LLC",
    "bank_name": "Sample Bank Name",
    "routing_number": "121140399",
    "account_holder_name": "Atomic Brokerage LLC",
    "account_number": "123-456789-0",
    "country_code": "USA",
    "street": "1234 5th Avenue, New York, NY 10011",
    "city": "New York",
    "region": "NY",
    "postal_code": "10011",
    "bic_code": "ABCDEF00",
    "minimum_deposit_amount": "1"
  },
  "created_at": "2025-01-12T10:00:00Z",
  "modified_at": "2025-01-12T14:30:00Z"
}