{ "opencollection": "1.0.0", "info": { "name": "Modern Treasury AccountCapability Document API", "version": "v1" }, "items": [ { "info": { "name": "Document", "type": "folder" }, "items": [ { "info": { "name": "list documents", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:3000/api/documents", "params": [ { "name": "documentable_id", "value": "", "type": "query", "description": "The unique identifier for the associated object." }, { "name": "documentable_type", "value": "", "type": "query", "description": "The type of the associated object. Currently can be one of `payment_order`, `transaction`, `expected_payment`, `counterparty`, `organization`, `case`, `internal_account`, `decision`, or `external_account`." }, { "name": "after_cursor", "value": "", "type": "query" }, { "name": "per_page", "value": "", "type": "query" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Get a list of documents." }, { "info": { "name": "create document", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:3000/api/documents", "headers": [ { "name": "Idempotency-Key", "value": "" } ], "body": { "type": "multipart-form", "data": [] }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create a document." }, { "info": { "name": "list documents - nested path (legacy)", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:3000/api/:documentable_type/:documentable_id/documents", "params": [ { "name": "documentable_id", "value": "", "type": "path", "description": "The unique identifier for the associated object." }, { "name": "documentable_type", "value": "", "type": "path", "description": "The type of the associated object. Currently can be one of `payment_order`, `transaction`, `expected_payment`, `counterparty`, `organization`, `case`, `internal_account`, `decision`, or `external_account`." }, { "name": "document_type", "value": "", "type": "query", "description": "A category given to the document, can be `null`." }, { "name": "after_cursor", "value": "", "type": "query" }, { "name": "per_page", "value": "", "type": "query" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Get a list of documents." }, { "info": { "name": "create document - nested path (legacy)", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:3000/api/:documentable_type/:documentable_id/documents", "headers": [ { "name": "Idempotency-Key", "value": "" } ], "params": [ { "name": "documentable_id", "value": "", "type": "path", "description": "The unique identifier for the associated object." }, { "name": "documentable_type", "value": "", "type": "path", "description": "The type of the associated object. Currently can be one of `payment_order`, `transaction`, `expected_payment`, `counterparty`, `organization`, `case`, `internal_account`, `decision`, or `external_account`." } ], "body": { "type": "multipart-form", "data": [] }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create a document." }, { "info": { "name": "get document - nested path (legacy)", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:3000/api/:documentable_type/:documentable_id/documents/:id", "params": [ { "name": "documentable_id", "value": "", "type": "path", "description": "The unique identifier for the associated object." }, { "name": "documentable_type", "value": "", "type": "path", "description": "The type of the associated object. Currently can be one of `payment_order`, `transaction`, `expected_payment`, `counterparty`, `organization`, `case`, `internal_account`, `decision`, or `external_account`." }, { "name": "id", "value": "", "type": "path", "description": "The ID of the document." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Get an existing document." }, { "info": { "name": "get document", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:3000/api/documents/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the document." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Get an existing document." }, { "info": { "name": "download document - nested path (legacy)", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:3000/api/:documentable_type/:documentable_id/documents/:id/download", "params": [ { "name": "documentable_id", "value": "", "type": "path", "description": "The unique identifier for the associated object." }, { "name": "documentable_type", "value": "", "type": "path", "description": "The type of the associated object. Currently can be one of `payment_order`, `transaction`, `expected_payment`, `counterparty`, `organization`, `case`, `internal_account`, `decision`, or `external_account`." }, { "name": "id", "value": "", "type": "path", "description": "The ID of the document." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Download an existing document." }, { "info": { "name": "download document", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:3000/api/documents/:id/download", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the document." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Download an existing document." } ] } ], "bundled": true }