{ "opencollection": "1.0.0", "info": { "name": "TransferZero Account Debits Transactions API", "version": "1.0" }, "request": { "auth": { "type": "apikey", "key": "Authorization-Key", "value": "{{Authorization-Key}}", "placement": "header" } }, "items": [ { "info": { "name": "Transactions", "type": "folder" }, "items": [ { "info": { "name": "Get a list of transactions", "type": "http" }, "http": { "method": "GET", "url": "https://api-sandbox.transferzero.com/v1/transactions", "params": [ { "name": "page", "value": "1", "type": "query", "description": "The page number to request (defaults to 1)" }, { "name": "per", "value": "10", "type": "query", "description": "The number of results to load per page (defaults to 10)" }, { "name": "external_id", "value": "", "type": "query", "description": "Allows filtering results by `external_id`.\n\nExample: `/v1/senders?external_id=26ec8517-2f0d-48c0-b74f-0bccb9ab3a87`" }, { "name": "sender_id", "value": "", "type": "query", "description": "Allows filtering results by `sender_id`.\n\nExample: `/v1/transactions?sender_id=b41d3cb7-6c54-4245-85fc-8e30690eb0f7`" }, { "name": "transactions_type", "value": "", "type": "query", "description": "Allows filtering results by `transactions_type`.\n\nExample: `/v1/transactions?transactions_type=automated`" } ] }, "docs": "Retrieves a paginated list of the Transactions created by your API key." }, { "info": { "name": "Creates a new transaction", "type": "http" }, "http": { "method": "POST", "url": "https://api-sandbox.transferzero.com/v1/transactions", "body": { "type": "json", "data": "{}" } }, "docs": "Transactions are the main objects in the TransferZero API, so it's important to understand how to create and manage them.\nTransactions facilitate money movement from one Sender in a specific currency to one or multiple Recipients in another currency.\n\nThe main flow of a successful transaction flow is the following -\n- Transaction is created linking the Sender to the Recipient(s) with the requested amounts.\n- Once the sender is KYC'd and approved the transaction can be funded.\n- Once the transact" }, { "info": { "name": "Calculates transaction amounts for a transaction payload", "type": "http" }, "http": { "method": "POST", "url": "https://api-sandbox.transferzero.com/v1/transactions/calculate", "body": { "type": "json", "data": "{}" } }, "docs": "Calculates the input, output and fee amounts for the recipients in a transaction payload" }, { "info": { "name": "Validates a transaction payload", "type": "http" }, "http": { "method": "POST", "url": "https://api-sandbox.transferzero.com/v1/transactions/validate", "body": { "type": "json", "data": "{}" } }, "docs": "Validates fields in a transaction payload and displays invalid or missing fields" }, { "info": { "name": "Creates a new transaction and funds it from account balance", "type": "http" }, "http": { "method": "POST", "url": "https://api-sandbox.transferzero.com/v1/transactions/create_and_fund", "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint creates a transaction and funds it from an account balance. You must ensure that you have established an account with us in the pay-in currency of the transactions you wish to create, and that this account is sufficently funded, before calling this endpoint.\n\nNote that the
external_id
field is required for requests to this endpoint." }, { "info": { "name": "Fetch a single transaction", "type": "http" }, "http": { "method": "GET", "url": "https://api-sandbox.transferzero.com/v1/transactions/:Transaction ID", "params": [ { "name": "Transaction ID", "value": "", "type": "path", "description": "ID of the transaction.\n\nExample: `/v1/transactions/bf9ff782-e182-45ac-abea-5bce83ad6670`" } ] }, "docs": "Finds and returns a Transaction created by the requesting API key, using\nthe provided Transaction ID." }, { "info": { "name": "Creates a fake payin for transaction", "type": "http" }, "http": { "method": "POST", "url": "https://api-sandbox.transferzero.com/v1/transactions/:Transaction ID/payin", "params": [ { "name": "Transaction ID", "value": "", "type": "path", "description": "ID of the transaction to payin.\n\nExample: `/v1/transactions/bf9ff782-e182-45ac-abea-5bce83ad6670/payin`" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This method is available only in sandbox environment and is supposed to be used only for testing integration.\nIt allows you to emulate a payin without paying actual money.\n" }, { "info": { "name": "Creates a fake payout for transaction", "type": "http" }, "http": { "method": "POST", "url": "https://api-sandbox.transferzero.com/v1/transactions/:Transaction ID/payout", "params": [ { "name": "Transaction ID", "value": "", "type": "path", "description": "ID of the transaction to payout.\n\nExample: `/v1/transactions/bf9ff782-e182-45ac-abea-5bce83ad6670/payout`" } ] }, "docs": "This method is available only in sandbox environment and is supposed to be used only for testing.\nIt allows you to emulate the payout of a transaction after payin.\n" } ] } ], "bundled": true }