{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "#/components/schemas/bulk_result", "title": "bulk_result", "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "object": { "type": "string" }, "live_mode": { "type": "boolean", "description": "This field will be true if this object exists in the live environment or false if it exists in the test environment." }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "request_id": { "type": "string", "format": "uuid", "description": "Unique identifier for the request that created this bulk result. This is the ID of the bulk request when `request_type` is bulk_request" }, "request_type": { "type": "string", "enum": [ "bulk_request" ], "description": "The type of the request that created this result. bulk_request is the only supported `request_type`" }, "status": { "type": "string", "enum": [ "pending", "successful", "failed" ], "description": "One of successful or failed." }, "request_params": { "type": "object", "description": "An optional object that contains the provided input params for the request that created this result. This is an item in the `resources` array for the bulk_request", "additionalProperties": { "type": "string" }, "nullable": true }, "entity_id": { "type": "string", "format": "uuid", "description": "Unique identifier for the result entity object." }, "entity_type": { "type": "string", "enum": [ "payment_order", "ledger_account", "ledger_transaction", "expected_payment", "transaction", "entity_link", "transaction_line_item", "bulk_error" ], "description": "The type of the result entity object. For a successful bulk result, this is the same as the `resource_type` of the bulk request. For a failed bulk result, this is always bulk_error" }, "entity": { "description": "An object with type as indicated by `entity_type`. This is the result object that is generated by performing the requested action on the provided input `request_params`.", "anyOf": [ { "$ref": "#/components/schemas/payment_order" }, { "$ref": "#/components/schemas/expected_payment" }, { "$ref": "#/components/schemas/ledger_transaction" }, { "$ref": "#/components/schemas/ledger_account" }, { "$ref": "#/components/schemas/transaction" }, { "$ref": "#/components/schemas/bulk_error" } ] } }, "additionalProperties": false, "minProperties": 12, "required": [ "id", "object", "live_mode", "created_at", "updated_at", "request_id", "request_type", "status", "request_params", "entity_id", "entity_type", "entity" ] }