Codat · Schema

Batch source account request creation response

Account ID and resulting object of the batch `Create source account` request.

Unified_API

Properties

Name Type Description
sourceAccountId string Unique ID for the source account.
result object
View JSON Schema on GitHub

JSON Schema

codat-sourceaccountbatchcreateresponse-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SourceAccountBatchCreateResponse",
  "title": "Batch source account request creation response",
  "description": "Account ID and resulting object of the batch `Create source account` request.",
  "type": "object",
  "properties": {
    "sourceAccountId": {
      "type": "string",
      "description": "Unique ID for the source account.",
      "examples": [
        "12345"
      ]
    },
    "result": {
      "$ref": "#/components/schemas/SourceAccountBatchCreateResponse/definitions/sourceAccountBatchCreateResult"
    }
  },
  "definitions": {
    "sourceAccountBatchCreateResult": {
      "title": "Source Account Batch Create Result",
      "description": "Status details and corresponding object of the `Create account` operation.",
      "type": "object",
      "properties": {
        "statusCode": {
          "type": "integer",
          "description": "The HTTP status code for the creation of the source account"
        },
        "error": {
          "type": "string",
          "nullable": true,
          "description": "A brief description of the error."
        },
        "account": {
          "$ref": "#/components/schemas/SourceAccount"
        }
      }
    }
  }
}