{ "opencollection": "1.0.0", "info": { "name": "Unified.to account payment API", "version": "1.0" }, "request": { "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "payment", "type": "folder" }, "items": [ { "info": { "name": "List All Links", "type": "http" }, "http": { "method": "GET", "url": "https://api.unified.to/payment/:connection_id/link", "params": [ { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "updated_gte", "value": "", "type": "query", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "name": "sort", "value": "", "type": "query" }, { "name": "order", "value": "", "type": "query" }, { "name": "query", "value": "", "type": "query", "description": "Query string to search. eg. email address or name" }, { "name": "contact_id", "value": "", "type": "query", "description": "The contact ID to filter by (reference to AccountingContact)" }, { "name": "payment_id", "value": "", "type": "query", "description": "The payment ID to filter by (reference to PaymentPayment)" }, { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "List All Links" }, { "info": { "name": "Create a Link", "type": "http" }, "http": { "method": "POST", "url": "https://api.unified.to/payment/:connection_id/link", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Create a Link" }, { "info": { "name": "Retrieve a Link", "type": "http" }, "http": { "method": "GET", "url": "https://api.unified.to/payment/:connection_id/link/:id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" }, { "name": "id", "value": "", "type": "path", "description": "ID of the Link" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Retrieve a Link" }, { "info": { "name": "Update a Link", "type": "http" }, "http": { "method": "PUT", "url": "https://api.unified.to/payment/:connection_id/link/:id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" }, { "name": "id", "value": "", "type": "path", "description": "ID of the Link" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Update a Link" }, { "info": { "name": "Update a Link", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.unified.to/payment/:connection_id/link/:id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" }, { "name": "id", "value": "", "type": "path", "description": "ID of the Link" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Update a Link" }, { "info": { "name": "Remove a Link", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.unified.to/payment/:connection_id/link/:id", "params": [ { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" }, { "name": "id", "value": "", "type": "path", "description": "ID of the Link" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Remove a Link" }, { "info": { "name": "List All Payments", "type": "http" }, "http": { "method": "GET", "url": "https://api.unified.to/payment/:connection_id/payment", "params": [ { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "updated_gte", "value": "", "type": "query", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "name": "sort", "value": "", "type": "query" }, { "name": "order", "value": "", "type": "query" }, { "name": "query", "value": "", "type": "query", "description": "Query string to search. eg. email address or name" }, { "name": "invoice_id", "value": "", "type": "query", "description": "The invoice ID to filter by (reference to AccountingInvoice)" }, { "name": "contact_id", "value": "", "type": "query", "description": "The contact ID to filter by (reference to AccountingContact)" }, { "name": "link_id", "value": "", "type": "query", "description": "The link ID to filter by" }, { "name": "bill_id", "value": "", "type": "query", "description": "The bill ID to filter by" }, { "name": "type", "value": "", "type": "query", "description": "The type to filter by" }, { "name": "org_id", "value": "", "type": "query", "description": "The org ID to filter by (reference to AccountingOrganization)" }, { "name": "start_gte", "value": "", "type": "query", "description": "The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "name": "end_lt", "value": "", "type": "query", "description": "The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "List All Payments" }, { "info": { "name": "Create a Payment", "type": "http" }, "http": { "method": "POST", "url": "https://api.unified.to/payment/:connection_id/payment", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Create a Payment" }, { "info": { "name": "Retrieve a Payment", "type": "http" }, "http": { "method": "GET", "url": "https://api.unified.to/payment/:connection_id/payment/:id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" }, { "name": "id", "value": "", "type": "path", "description": "ID of the Payment" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Retrieve a Payment" }, { "info": { "name": "Update a Payment", "type": "http" }, "http": { "method": "PUT", "url": "https://api.unified.to/payment/:connection_id/payment/:id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" }, { "name": "id", "value": "", "type": "path", "description": "ID of the Payment" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Update a Payment" }, { "info": { "name": "Update a Payment", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.unified.to/payment/:connection_id/payment/:id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" }, { "name": "id", "value": "", "type": "path", "description": "ID of the Payment" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Update a Payment" }, { "info": { "name": "Remove a Payment", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.unified.to/payment/:connection_id/payment/:id", "params": [ { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" }, { "name": "id", "value": "", "type": "path", "description": "ID of the Payment" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Remove a Payment" }, { "info": { "name": "List All Payouts", "type": "http" }, "http": { "method": "GET", "url": "https://api.unified.to/payment/:connection_id/payout", "params": [ { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "updated_gte", "value": "", "type": "query", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "name": "sort", "value": "", "type": "query" }, { "name": "order", "value": "", "type": "query" }, { "name": "query", "value": "", "type": "query", "description": "Query string to search. eg. email address or name" }, { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "List All Payouts" }, { "info": { "name": "Retrieve a Payout", "type": "http" }, "http": { "method": "GET", "url": "https://api.unified.to/payment/:connection_id/payout/:id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" }, { "name": "id", "value": "", "type": "path", "description": "ID of the Payout" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Retrieve a Payout" }, { "info": { "name": "List All Refunds", "type": "http" }, "http": { "method": "GET", "url": "https://api.unified.to/payment/:connection_id/refund", "params": [ { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "updated_gte", "value": "", "type": "query", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "name": "sort", "value": "", "type": "query" }, { "name": "order", "value": "", "type": "query" }, { "name": "query", "value": "", "type": "query", "description": "Query string to search. eg. email address or name" }, { "name": "payment_id", "value": "", "type": "query", "description": "The payment ID to filter by (reference to PaymentPayment)" }, { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "List All Refunds" }, { "info": { "name": "Retrieve a Refund", "type": "http" }, "http": { "method": "GET", "url": "https://api.unified.to/payment/:connection_id/refund/:id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" }, { "name": "id", "value": "", "type": "path", "description": "ID of the Refund" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Retrieve a Refund" }, { "info": { "name": "List All Subscriptions", "type": "http" }, "http": { "method": "GET", "url": "https://api.unified.to/payment/:connection_id/subscription", "params": [ { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "updated_gte", "value": "", "type": "query", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "name": "sort", "value": "", "type": "query" }, { "name": "order", "value": "", "type": "query" }, { "name": "query", "value": "", "type": "query", "description": "Query string to search. eg. email address or name" }, { "name": "contact_id", "value": "", "type": "query", "description": "The contact ID to filter by (reference to AccountingContact)" }, { "name": "start_gte", "value": "", "type": "query", "description": "The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "name": "end_lt", "value": "", "type": "query", "description": "The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "List All Subscriptions" }, { "info": { "name": "Create a Subscription", "type": "http" }, "http": { "method": "POST", "url": "https://api.unified.to/payment/:connection_id/subscription", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Create a Subscription" }, { "info": { "name": "Retrieve a Subscription", "type": "http" }, "http": { "method": "GET", "url": "https://api.unified.to/payment/:connection_id/subscription/:id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" }, { "name": "id", "value": "", "type": "path", "description": "ID of the Subscription" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Retrieve a Subscription" }, { "info": { "name": "Update a Subscription", "type": "http" }, "http": { "method": "PUT", "url": "https://api.unified.to/payment/:connection_id/subscription/:id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" }, { "name": "id", "value": "", "type": "path", "description": "ID of the Subscription" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Update a Subscription" }, { "info": { "name": "Update a Subscription", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.unified.to/payment/:connection_id/subscription/:id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" }, { "name": "id", "value": "", "type": "path", "description": "ID of the Subscription" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Update a Subscription" }, { "info": { "name": "Remove a Subscription", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.unified.to/payment/:connection_id/subscription/:id", "params": [ { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" }, { "name": "id", "value": "", "type": "path", "description": "ID of the Subscription" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Remove a Subscription" } ] } ], "bundled": true }