Jump to

• Request
• Response

Get Pending CBDC Requests

get

{baseUrl}/v1/{contractAddress}/{ordsPathPrefix}/getPendingCBDCRequest

Retrieves pending CBDC requests of the specified type. Generated from `ORDS GET /getPendingCBDCRequest`.

Request

Path Parameters

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

Query Parameters

• request_type: string
• 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":{
                    "blockno":{
                        "$ref":"#/components/schemas/ORDS_NUMBER"
                    },
                    "blocktimestamp":{
                        "$ref":"#/components/schemas/ORDS_TIMESTAMP"
                    },
                    "category":{
                        "$ref":"#/components/schemas/ORDS_VARCHAR2"
                    },
                    "description":{
                        "$ref":"#/components/schemas/ORDS_VARCHAR2"
                    },
                    "expiration_time":{
                        "$ref":"#/components/schemas/ORDS_VARCHAR2"
                    },
                    "from_account_id":{
                        "$ref":"#/components/schemas/ORDS_VARCHAR2"
                    },
                    "functionname":{
                        "$ref":"#/components/schemas/ORDS_VARCHAR2"
                    },
                    "holding_id":{
                        "$ref":"#/components/schemas/ORDS_VARCHAR2"
                    },
                    "notary_account_id":{
                        "$ref":"#/components/schemas/ORDS_VARCHAR2"
                    },
                    "op_type":{
                        "$ref":"#/components/schemas/ORDS_VARCHAR2"
                    },
                    "original_quantity":{
                        "$ref":"#/components/schemas/ORDS_VARCHAR2"
                    },
                    "quantity":{
                        "$ref":"#/components/schemas/ORDS_VARCHAR2"
                    },
                    "status":{
                        "$ref":"#/components/schemas/ORDS_VARCHAR2"
                    },
                    "status_label":{
                        "$ref":"#/components/schemas/ORDS_VARCHAR2"
                    },
                    "storage_key":{
                        "$ref":"#/components/schemas/ORDS_VARCHAR2"
                    },
                    "token_id":{
                        "$ref":"#/components/schemas/ORDS_VARCHAR2"
                    },
                    "token_name":{
                        "$ref":"#/components/schemas/ORDS_VARCHAR2"
                    },
                    "to_account_id":{
                        "$ref":"#/components/schemas/ORDS_VARCHAR2"
                    },
                    "txnhash":{
                        "$ref":"#/components/schemas/ORDS_VARCHAR2"
                    },
                    "txnno":{
                        "$ref":"#/components/schemas/ORDS_NUMBER"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "blockno":{
                "$ref":"#/components/schemas/ORDS_NUMBER"
            },
            "blocktimestamp":{
                "$ref":"#/components/schemas/ORDS_TIMESTAMP"
            },
            "category":{
                "$ref":"#/components/schemas/ORDS_VARCHAR2"
            },
            "description":{
                "$ref":"#/components/schemas/ORDS_VARCHAR2"
            },
            "expiration_time":{
                "$ref":"#/components/schemas/ORDS_VARCHAR2"
            },
            "from_account_id":{
                "$ref":"#/components/schemas/ORDS_VARCHAR2"
            },
            "functionname":{
                "$ref":"#/components/schemas/ORDS_VARCHAR2"
            },
            "holding_id":{
                "$ref":"#/components/schemas/ORDS_VARCHAR2"
            },
            "notary_account_id":{
                "$ref":"#/components/schemas/ORDS_VARCHAR2"
            },
            "op_type":{
                "$ref":"#/components/schemas/ORDS_VARCHAR2"
            },
            "original_quantity":{
                "$ref":"#/components/schemas/ORDS_VARCHAR2"
            },
            "quantity":{
                "$ref":"#/components/schemas/ORDS_VARCHAR2"
            },
            "status":{
                "$ref":"#/components/schemas/ORDS_VARCHAR2"
            },
            "status_label":{
                "$ref":"#/components/schemas/ORDS_VARCHAR2"
            },
            "storage_key":{
                "$ref":"#/components/schemas/ORDS_VARCHAR2"
            },
            "token_id":{
                "$ref":"#/components/schemas/ORDS_VARCHAR2"
            },
            "token_name":{
                "$ref":"#/components/schemas/ORDS_VARCHAR2"
            },
            "to_account_id":{
                "$ref":"#/components/schemas/ORDS_VARCHAR2"
            },
            "txnhash":{
                "$ref":"#/components/schemas/ORDS_VARCHAR2"
            },
            "txnno":{
                "$ref":"#/components/schemas/ORDS_NUMBER"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• blockno: number
• blocktimestamp: 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))$
• category: string
• description: string
• expiration_time: string
• from_account_id: string
• functionname: string
• holding_id: string
• notary_account_id: string
• op_type: string
• original_quantity: string
• quantity: string
• status: string
• status_label: string
• storage_key: string
• to_account_id: string
• token_id: string
• token_name: string
• txnhash: string
• txnno: number

{
    "type":"object",
    "properties":{
        "blockno":{
            "$ref":"#/components/schemas/ORDS_NUMBER"
        },
        "blocktimestamp":{
            "$ref":"#/components/schemas/ORDS_TIMESTAMP"
        },
        "category":{
            "$ref":"#/components/schemas/ORDS_VARCHAR2"
        },
        "description":{
            "$ref":"#/components/schemas/ORDS_VARCHAR2"
        },
        "expiration_time":{
            "$ref":"#/components/schemas/ORDS_VARCHAR2"
        },
        "from_account_id":{
            "$ref":"#/components/schemas/ORDS_VARCHAR2"
        },
        "functionname":{
            "$ref":"#/components/schemas/ORDS_VARCHAR2"
        },
        "holding_id":{
            "$ref":"#/components/schemas/ORDS_VARCHAR2"
        },
        "notary_account_id":{
            "$ref":"#/components/schemas/ORDS_VARCHAR2"
        },
        "op_type":{
            "$ref":"#/components/schemas/ORDS_VARCHAR2"
        },
        "original_quantity":{
            "$ref":"#/components/schemas/ORDS_VARCHAR2"
        },
        "quantity":{
            "$ref":"#/components/schemas/ORDS_VARCHAR2"
        },
        "status":{
            "$ref":"#/components/schemas/ORDS_VARCHAR2"
        },
        "status_label":{
            "$ref":"#/components/schemas/ORDS_VARCHAR2"
        },
        "storage_key":{
            "$ref":"#/components/schemas/ORDS_VARCHAR2"
        },
        "token_id":{
            "$ref":"#/components/schemas/ORDS_VARCHAR2"
        },
        "token_name":{
            "$ref":"#/components/schemas/ORDS_VARCHAR2"
        },
        "to_account_id":{
            "$ref":"#/components/schemas/ORDS_VARCHAR2"
        },
        "txnhash":{
            "$ref":"#/components/schemas/ORDS_VARCHAR2"
        },
        "txnno":{
            "$ref":"#/components/schemas/ORDS_NUMBER"
        }
    }
}

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