Jump to

• Request
• Response

Get CBDC Accounts

get

{baseUrl}/v1/{contractAddress}/{ordsPathPrefix}/getAllCBDCAccounts

Retrieves all CBDC accounts for the specified token. Generated from ORDS GET /getAllCBDCAccounts.

Request

Path Parameters

• contractAddress(required): string
  Path parameter
• ordsPathPrefix(required): string
  Path parameter

Query Parameters

• token_id: string

Header Parameters

• X-Service-Token(required): string
  Service token forwarded to ORDS as the Authorization header.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

The queried record.

Body ()

Root Schema : schema

Type: object

Show Source

• items: array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "account_address":{
                        "$ref":"#/components/schemas/ORDS_VARCHAR2"
                    },
                    "account_id":{
                        "$ref":"#/components/schemas/ORDS_VARCHAR2"
                    },
                    "application_groups":{
                        "$ref":"#/components/schemas/ORDS_VARCHAR2"
                    },
                    "balance":{
                        "$ref":"#/components/schemas/ORDS_VARCHAR2"
                    },
                    "created_blockno":{
                        "$ref":"#/components/schemas/ORDS_NUMBER"
                    },
                    "created_timestamp":{
                        "$ref":"#/components/schemas/ORDS_TIMESTAMP"
                    },
                    "created_txnhash":{
                        "$ref":"#/components/schemas/ORDS_VARCHAR2"
                    },
                    "created_txnno":{
                        "$ref":"#/components/schemas/ORDS_NUMBER"
                    },
                    "daily_amount":{
                        "$ref":"#/components/schemas/ORDS_VARCHAR2"
                    },
                    "daily_transactions":{
                        "$ref":"#/components/schemas/ORDS_VARCHAR2"
                    },
                    "max_daily_amount":{
                        "$ref":"#/components/schemas/ORDS_VARCHAR2"
                    },
                    "max_daily_transactions":{
                        "$ref":"#/components/schemas/ORDS_VARCHAR2"
                    },
                    "onhold_balance":{
                        "$ref":"#/components/schemas/ORDS_VARCHAR2"
                    },
                    "onhold_burn_balance":{
                        "$ref":"#/components/schemas/ORDS_CHAR"
                    },
                    "org_id":{
                        "$ref":"#/components/schemas/ORDS_VARCHAR2"
                    },
                    "status":{
                        "$ref":"#/components/schemas/ORDS_VARCHAR2"
                    },
                    "token_id":{
                        "$ref":"#/components/schemas/ORDS_VARCHAR2"
                    },
                    "token_name":{
                        "$ref":"#/components/schemas/ORDS_VARCHAR2"
                    },
                    "user_id":{
                        "$ref":"#/components/schemas/ORDS_VARCHAR2"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "account_address":{
                "$ref":"#/components/schemas/ORDS_VARCHAR2"
            },
            "account_id":{
                "$ref":"#/components/schemas/ORDS_VARCHAR2"
            },
            "application_groups":{
                "$ref":"#/components/schemas/ORDS_VARCHAR2"
            },
            "balance":{
                "$ref":"#/components/schemas/ORDS_VARCHAR2"
            },
            "created_blockno":{
                "$ref":"#/components/schemas/ORDS_NUMBER"
            },
            "created_timestamp":{
                "$ref":"#/components/schemas/ORDS_TIMESTAMP"
            },
            "created_txnhash":{
                "$ref":"#/components/schemas/ORDS_VARCHAR2"
            },
            "created_txnno":{
                "$ref":"#/components/schemas/ORDS_NUMBER"
            },
            "daily_amount":{
                "$ref":"#/components/schemas/ORDS_VARCHAR2"
            },
            "daily_transactions":{
                "$ref":"#/components/schemas/ORDS_VARCHAR2"
            },
            "max_daily_amount":{
                "$ref":"#/components/schemas/ORDS_VARCHAR2"
            },
            "max_daily_transactions":{
                "$ref":"#/components/schemas/ORDS_VARCHAR2"
            },
            "onhold_balance":{
                "$ref":"#/components/schemas/ORDS_VARCHAR2"
            },
            "onhold_burn_balance":{
                "$ref":"#/components/schemas/ORDS_CHAR"
            },
            "org_id":{
                "$ref":"#/components/schemas/ORDS_VARCHAR2"
            },
            "status":{
                "$ref":"#/components/schemas/ORDS_VARCHAR2"
            },
            "token_id":{
                "$ref":"#/components/schemas/ORDS_VARCHAR2"
            },
            "token_name":{
                "$ref":"#/components/schemas/ORDS_VARCHAR2"
            },
            "user_id":{
                "$ref":"#/components/schemas/ORDS_VARCHAR2"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• account_address: string
• account_id: string
• application_groups: string
• balance: string
• created_blockno: number
• created_timestamp: string (date-time)
  Pattern: ^\d{4}-[01]\d-[0123]\dT[012]\d:[0-5]\d:[0-5]\d(.\d+)?(Z|([-+][012]\d:[0-5]\d))$
• created_txnhash: string
• created_txnno: number
• daily_amount: string
• daily_transactions: string
• max_daily_amount: string
• max_daily_transactions: string
• onhold_balance: string
• onhold_burn_balance: string
• org_id: string
• status: string
• token_id: string
• token_name: string
• user_id: string

{
    "type":"object",
    "properties":{
        "account_address":{
            "$ref":"#/components/schemas/ORDS_VARCHAR2"
        },
        "account_id":{
            "$ref":"#/components/schemas/ORDS_VARCHAR2"
        },
        "application_groups":{
            "$ref":"#/components/schemas/ORDS_VARCHAR2"
        },
        "balance":{
            "$ref":"#/components/schemas/ORDS_VARCHAR2"
        },
        "created_blockno":{
            "$ref":"#/components/schemas/ORDS_NUMBER"
        },
        "created_timestamp":{
            "$ref":"#/components/schemas/ORDS_TIMESTAMP"
        },
        "created_txnhash":{
            "$ref":"#/components/schemas/ORDS_VARCHAR2"
        },
        "created_txnno":{
            "$ref":"#/components/schemas/ORDS_NUMBER"
        },
        "daily_amount":{
            "$ref":"#/components/schemas/ORDS_VARCHAR2"
        },
        "daily_transactions":{
            "$ref":"#/components/schemas/ORDS_VARCHAR2"
        },
        "max_daily_amount":{
            "$ref":"#/components/schemas/ORDS_VARCHAR2"
        },
        "max_daily_transactions":{
            "$ref":"#/components/schemas/ORDS_VARCHAR2"
        },
        "onhold_balance":{
            "$ref":"#/components/schemas/ORDS_VARCHAR2"
        },
        "onhold_burn_balance":{
            "$ref":"#/components/schemas/ORDS_CHAR"
        },
        "org_id":{
            "$ref":"#/components/schemas/ORDS_VARCHAR2"
        },
        "status":{
            "$ref":"#/components/schemas/ORDS_VARCHAR2"
        },
        "token_id":{
            "$ref":"#/components/schemas/ORDS_VARCHAR2"
        },
        "token_name":{
            "$ref":"#/components/schemas/ORDS_VARCHAR2"
        },
        "user_id":{
            "$ref":"#/components/schemas/ORDS_VARCHAR2"
        }
    }
}

400 Response

The wrapper rejected the request before it could complete a downstream call.

Body ()

Root Schema : Wrapper_Error

Type: object

Show Source

• error(required): string
• status(required): integer

{
    "type":"object",
    "properties":{
        "status":{
            "type":"integer"
        },
        "error":{
            "type":"string"
        }
    },
    "required":[
        "status",
        "error"
    ]
}

502 Response

The wrapper could not complete the downstream call.

Body ()

Root Schema : Wrapper_Error

Type: object

Show Source

• error(required): string
• status(required): integer

{
    "type":"object",
    "properties":{
        "status":{
            "type":"integer"
        },
        "error":{
            "type":"string"
        }
    },
    "required":[
        "status",
        "error"
    ]
}

Default Response

ORDS upstream status, content type, and response body are passed through unchanged.

Back to Top