Jump to

• Request
• Response

Register Contract Endpoints

post

{baseUrl}/v1/register

Registers contract endpoint templates. The Postman collection contains two distinct POST /register requests using the same HTTP path: one for the wholesale CBDC token/holdable contract and one for the account/ERC-5982/UUPS contract. Both request variants are represented below as named examples.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Additional Properties Allowed: true

Request shape used by both POST /register variants in the Postman collection.

Show Source

• contractAddress: string
• endpoints: array endpoints
• readConfigs: object readConfigs
  Additional Properties Allowed: true
• writeConfigs: object writeConfigs
  Additional Properties Allowed: true

{
    "type":"object",
    "properties":{
        "contractAddress":{
            "type":"string"
        },
        "writeConfigs":{
            "type":"object",
            "properties":{
                "type":{
                    "type":"integer",
                    "format":"int64"
                },
                "gasLimit":{
                    "type":"integer",
                    "format":"int64"
                },
                "waitForReceipt":{
                    "type":"boolean"
                },
                "receiptWaitMs":{
                    "type":"integer",
                    "format":"int64"
                },
                "receiptMaxTries":{
                    "type":"integer",
                    "format":"int64"
                },
                "decode":{
                    "type":"object",
                    "properties":{
                        "inputs":{
                            "type":"boolean"
                        },
                        "events":{
                            "type":"boolean"
                        },
                        "errors":{
                            "type":"boolean"
                        }
                    },
                    "additionalProperties":true
                }
            },
            "additionalProperties":true
        },
        "readConfigs":{
            "type":"object",
            "properties":{
                "blockTag":{
                    "type":"string"
                },
                "decode":{
                    "type":"object",
                    "properties":{
                        "outputs":{
                            "type":"boolean"
                        },
                        "errors":{
                            "type":"boolean"
                        }
                    },
                    "additionalProperties":true
                }
            },
            "additionalProperties":true
        },
        "endpoints":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "path":{
                        "type":"string"
                    },
                    "httpMethod":{
                        "type":"string"
                    },
                    "contractMethod":{
                        "type":"object",
                        "properties":{
                            "name":{
                                "type":"string"
                            },
                            "signature":{
                                "type":"string"
                            }
                        },
                        "additionalProperties":true
                    },
                    "args":{
                        "type":"array",
                        "items":{
                            "type":"string"
                        }
                    },
                    "generatePostmanApi":{
                        "type":"boolean"
                    }
                },
                "additionalProperties":true
            }
        }
    },
    "additionalProperties":true,
    "description":"Request shape used by both POST /register variants in the Postman\ncollection."
}

Nested Schema : endpoints

Type: array

Show Source

• Array of: object items
  Additional Properties Allowed: true

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "path":{
                "type":"string"
            },
            "httpMethod":{
                "type":"string"
            },
            "contractMethod":{
                "type":"object",
                "properties":{
                    "name":{
                        "type":"string"
                    },
                    "signature":{
                        "type":"string"
                    }
                },
                "additionalProperties":true
            },
            "args":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            },
            "generatePostmanApi":{
                "type":"boolean"
            }
        },
        "additionalProperties":true
    }
}

Nested Schema : readConfigs

Type: object

Additional Properties Allowed: true

Show Source

• blockTag: string
• decode: object decode
  Additional Properties Allowed: true

{
    "type":"object",
    "properties":{
        "blockTag":{
            "type":"string"
        },
        "decode":{
            "type":"object",
            "properties":{
                "outputs":{
                    "type":"boolean"
                },
                "errors":{
                    "type":"boolean"
                }
            },
            "additionalProperties":true
        }
    },
    "additionalProperties":true
}

Nested Schema : writeConfigs

Type: object

Additional Properties Allowed: true

Show Source

• decode: object decode
  Additional Properties Allowed: true
• gasLimit: integer (int64)
• receiptMaxTries: integer (int64)
• receiptWaitMs: integer (int64)
• type: integer (int64)
• waitForReceipt: boolean

{
    "type":"object",
    "properties":{
        "type":{
            "type":"integer",
            "format":"int64"
        },
        "gasLimit":{
            "type":"integer",
            "format":"int64"
        },
        "waitForReceipt":{
            "type":"boolean"
        },
        "receiptWaitMs":{
            "type":"integer",
            "format":"int64"
        },
        "receiptMaxTries":{
            "type":"integer",
            "format":"int64"
        },
        "decode":{
            "type":"object",
            "properties":{
                "inputs":{
                    "type":"boolean"
                },
                "events":{
                    "type":"boolean"
                },
                "errors":{
                    "type":"boolean"
                }
            },
            "additionalProperties":true
        }
    },
    "additionalProperties":true
}

Nested Schema : items

Type: object

Additional Properties Allowed: true

Show Source

• args: array args
• contractMethod: object contractMethod
  Additional Properties Allowed: true
• generatePostmanApi: boolean
• httpMethod: string
• path: string

{
    "type":"object",
    "properties":{
        "path":{
            "type":"string"
        },
        "httpMethod":{
            "type":"string"
        },
        "contractMethod":{
            "type":"object",
            "properties":{
                "name":{
                    "type":"string"
                },
                "signature":{
                    "type":"string"
                }
            },
            "additionalProperties":true
        },
        "args":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "generatePostmanApi":{
            "type":"boolean"
        }
    },
    "additionalProperties":true
}

Nested Schema : args

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : contractMethod

Type: object

Additional Properties Allowed: true

Show Source

• name: string
• signature: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "signature":{
            "type":"string"
        }
    },
    "additionalProperties":true
}

Nested Schema : decode

Type: object

Additional Properties Allowed: true

Show Source

• errors: boolean
• outputs: boolean

{
    "type":"object",
    "properties":{
        "outputs":{
            "type":"boolean"
        },
        "errors":{
            "type":"boolean"
        }
    },
    "additionalProperties":true
}

Nested Schema : decode

Type: object

Additional Properties Allowed: true

Show Source

• errors: boolean
• events: boolean
• inputs: boolean

{
    "type":"object",
    "properties":{
        "inputs":{
            "type":"boolean"
        },
        "events":{
            "type":"boolean"
        },
        "errors":{
            "type":"boolean"
        }
    },
    "additionalProperties":true
}

Examples

Select an example Wholesale CBDC token / holdable contract registration Account / ERC-5982 UUPS contract registration

Back to Top

Response

Supported Media Types

• application/json

200 Response

Contract template registered successfully.

Body ()

Root Schema : Register_SuccessResponse

Type: object

Show Source

• schema(required): object RegisteredSchema
• status(required): string

{
    "type":"object",
    "required":[
        "status",
        "schema"
    ],
    "properties":{
        "status":{
            "type":"string",
            "const":"success"
        },
        "schema":{
            "$ref":"#/components/schemas/RegisteredSchema"
        }
    }
}

Nested Schema : RegisteredSchema

Type: object

Show Source

• combinedApis(required): array combinedApis
• contractAddress(required): string
  Pattern: ^0x[a-fA-F0-9]{40}$
• endpoints(required): array endpoints
• readConfigs(required): object readConfigs
  Additional Properties Allowed: true
• writeConfigs(required): object writeConfigs
  Additional Properties Allowed: true

{
    "type":"object",
    "required":[
        "contractAddress",
        "writeConfigs",
        "readConfigs",
        "endpoints",
        "combinedApis"
    ],
    "properties":{
        "contractAddress":{
            "type":"string",
            "pattern":"^0x[a-fA-F0-9]{40}$"
        },
        "writeConfigs":{
            "type":"object",
            "additionalProperties":true
        },
        "readConfigs":{
            "type":"object",
            "additionalProperties":true
        },
        "endpoints":{
            "type":"array",
            "items":{
                "type":"object",
                "additionalProperties":true
            }
        },
        "combinedApis":{
            "type":"array",
            "items":{
                "type":"object",
                "additionalProperties":true
            }
        }
    }
}

Nested Schema : combinedApis

Type: array

Show Source

• Array of: object items
  Additional Properties Allowed: true

{
    "type":"array",
    "items":{
        "type":"object",
        "additionalProperties":true
    }
}

Nested Schema : endpoints

Type: array

Show Source

• Array of: object items
  Additional Properties Allowed: true

{
    "type":"array",
    "items":{
        "type":"object",
        "additionalProperties":true
    }
}

Nested Schema : readConfigs

Type: object

Additional Properties Allowed: true

Nested Schema : writeConfigs

Type: object

Additional Properties Allowed: true

Nested Schema : items

Type: object

Additional Properties Allowed: true

Nested Schema : items

Type: object

Additional Properties Allowed: true

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"
    ]
}

401 Response

A valid Bearer token with a supported user claim is required.

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"
    ]
}

415 Response

Content-Type must be application/json.

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"
    ]
}

Back to Top