{ "opencollection": "1.0.0", "info": { "name": "Modern Treasury AccountCapability Transaction API", "version": "v1" }, "items": [ { "info": { "name": "Transaction", "type": "folder" }, "items": [ { "info": { "name": "list transactions", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:3000/api/transactions", "params": [ { "name": "after_cursor", "value": "", "type": "query" }, { "name": "per_page", "value": "", "type": "query" }, { "name": "internal_account_id", "value": "", "type": "query", "description": "Specify `internal_account_id` if you wish to see transactions to/from a specific account." }, { "name": "virtual_account_id", "value": "", "type": "query" }, { "name": "posted", "value": "", "type": "query", "description": "Either `true` or `false`." }, { "name": "as_of_date_start", "value": "", "type": "query", "description": "Filters transactions with an `as_of_date` starting on or after the specified date (YYYY-MM-DD)." }, { "name": "as_of_date_end", "value": "", "type": "query", "description": "Filters transactions with an `as_of_date` starting on or before the specified date (YYYY-MM-DD)." }, { "name": "direction", "value": "", "type": "query" }, { "name": "counterparty_id", "value": "", "type": "query" }, { "name": "payment_type", "value": "", "type": "query" }, { "name": "transactable_type", "value": "", "type": "query" }, { "name": "description", "value": "", "type": "query", "description": "Filters for transactions including the queried string in the description." }, { "name": "vendor_id", "value": "", "type": "query", "description": "Filters for transactions including the queried vendor id (an identifier given to transactions by the bank)." }, { "name": "metadata", "value": "", "type": "query", "description": "For example, if you want to query for records with metadata key `Type` and value `Loan`, the query would be `metadata%5BType%5D=Loan`. This encodes the query parameters." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Get a list of all transactions." }, { "info": { "name": "create transaction", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:3000/api/transactions", "headers": [ { "name": "Idempotency-Key", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "create transaction" }, { "info": { "name": "get transaction", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:3000/api/transactions/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Transaction ID" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Get details on a single transaction." }, { "info": { "name": "update transaction", "type": "http" }, "http": { "method": "PATCH", "url": "http://localhost:3000/api/transactions/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Transaction ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Update a single transaction." }, { "info": { "name": "delete transaction", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:3000/api/transactions/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Transaction ID" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "delete transaction" } ] } ], "bundled": true }