Jump to

• Request
• Response

Get CBDC Transaction by ID

get

{baseUrl}/v1/{contractAddress}/{ordsPathPrefix}/getCBDCTransactionById

Retrieves a CBDC transaction by its identifier. Generated from `ORDS GET /getCBDCTransactionById`.

Request

Path Parameters

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

Query Parameters

• token_id: string
• transaction_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":{
                    "amount":{
                        "$ref":"#/components/schemas/ORDS_VARCHAR2"
                    },
                    "block_number":{
                        "$ref":"#/components/schemas/ORDS_NUMBER"
                    },
                    "from_account_id":{
                        "$ref":"#/components/schemas/ORDS_VARCHAR2"
                    },
                    "from_org_id":{
                        "$ref":"#/components/schemas/ORDS_VARCHAR2"
                    },
                    "from_user_id":{
                        "$ref":"#/components/schemas/ORDS_VARCHAR2"
                    },
                    "holding_id":{
                        "$ref":"#/components/schemas/ORDS_VARCHAR2"
                    },
                    "operation_id":{
                        "$ref":"#/components/schemas/ORDS_VARCHAR2"
                    },
                    "purpose":{
                        "$ref":"#/components/schemas/ORDS_VARCHAR2"
                    },
                    "timestamp":{
                        "$ref":"#/components/schemas/ORDS_TIMESTAMP"
                    },
                    "token_id":{
                        "$ref":"#/components/schemas/ORDS_VARCHAR2"
                    },
                    "to_account_id":{
                        "$ref":"#/components/schemas/ORDS_VARCHAR2"
                    },
                    "to_org_id":{
                        "$ref":"#/components/schemas/ORDS_VARCHAR2"
                    },
                    "to_user_id":{
                        "$ref":"#/components/schemas/ORDS_VARCHAR2"
                    },
                    "transaction_id":{
                        "$ref":"#/components/schemas/ORDS_VARCHAR2"
                    },
                    "transaction_type":{
                        "$ref":"#/components/schemas/ORDS_VARCHAR2"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "amount":{
                "$ref":"#/components/schemas/ORDS_VARCHAR2"
            },
            "block_number":{
                "$ref":"#/components/schemas/ORDS_NUMBER"
            },
            "from_account_id":{
                "$ref":"#/components/schemas/ORDS_VARCHAR2"
            },
            "from_org_id":{
                "$ref":"#/components/schemas/ORDS_VARCHAR2"
            },
            "from_user_id":{
                "$ref":"#/components/schemas/ORDS_VARCHAR2"
            },
            "holding_id":{
                "$ref":"#/components/schemas/ORDS_VARCHAR2"
            },
            "operation_id":{
                "$ref":"#/components/schemas/ORDS_VARCHAR2"
            },
            "purpose":{
                "$ref":"#/components/schemas/ORDS_VARCHAR2"
            },
            "timestamp":{
                "$ref":"#/components/schemas/ORDS_TIMESTAMP"
            },
            "token_id":{
                "$ref":"#/components/schemas/ORDS_VARCHAR2"
            },
            "to_account_id":{
                "$ref":"#/components/schemas/ORDS_VARCHAR2"
            },
            "to_org_id":{
                "$ref":"#/components/schemas/ORDS_VARCHAR2"
            },
            "to_user_id":{
                "$ref":"#/components/schemas/ORDS_VARCHAR2"
            },
            "transaction_id":{
                "$ref":"#/components/schemas/ORDS_VARCHAR2"
            },
            "transaction_type":{
                "$ref":"#/components/schemas/ORDS_VARCHAR2"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• amount: string
• block_number: number
• from_account_id: string
• from_org_id: string
• from_user_id: string
• holding_id: string
• operation_id: string
• purpose: string
• 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))$
• to_account_id: string
• to_org_id: string
• to_user_id: string
• token_id: string
• transaction_id: string
• transaction_type: string

{
    "type":"object",
    "properties":{
        "amount":{
            "$ref":"#/components/schemas/ORDS_VARCHAR2"
        },
        "block_number":{
            "$ref":"#/components/schemas/ORDS_NUMBER"
        },
        "from_account_id":{
            "$ref":"#/components/schemas/ORDS_VARCHAR2"
        },
        "from_org_id":{
            "$ref":"#/components/schemas/ORDS_VARCHAR2"
        },
        "from_user_id":{
            "$ref":"#/components/schemas/ORDS_VARCHAR2"
        },
        "holding_id":{
            "$ref":"#/components/schemas/ORDS_VARCHAR2"
        },
        "operation_id":{
            "$ref":"#/components/schemas/ORDS_VARCHAR2"
        },
        "purpose":{
            "$ref":"#/components/schemas/ORDS_VARCHAR2"
        },
        "timestamp":{
            "$ref":"#/components/schemas/ORDS_TIMESTAMP"
        },
        "token_id":{
            "$ref":"#/components/schemas/ORDS_VARCHAR2"
        },
        "to_account_id":{
            "$ref":"#/components/schemas/ORDS_VARCHAR2"
        },
        "to_org_id":{
            "$ref":"#/components/schemas/ORDS_VARCHAR2"
        },
        "to_user_id":{
            "$ref":"#/components/schemas/ORDS_VARCHAR2"
        },
        "transaction_id":{
            "$ref":"#/components/schemas/ORDS_VARCHAR2"
        },
        "transaction_type":{
            "$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