{"title":"Track transactions","category":"default","creationDate":1776961628,"content":"<p>To keep track of funds movements in your balance platform, you can use the  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/transfers\/latest\/overview\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">Transfers API<\/a> API. With this API, you can query the  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/transfers\/latest\/get\/transactions\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">\/transactions<\/a> endpoint for your whole balance platform, a particular account holder, or balance account. On this page you can:<\/p>\n<ul>\n<li>Get updates through <a href=\"\/pt\/payouts\/payout-service\/webhook-types\">webhooks<\/a>.\n<\/li>\n<li>Make API requests to keep track of transactions.<\/li>\n<\/ul>\n<h2>Requirements<\/h2>\n<table>\n<thead>\n<tr>\n<th style=\"text-align: left;\">Requirement<\/th>\n<th style=\"text-align: left;\">Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td style=\"text-align: left;\"><strong>Integration type<\/strong><\/td>\n<td style=\"text-align: left;\">You must have an <a href=\"\/pt\/adyen-for-platforms-model\/\">Adyen for Platforms<\/a>, <a href=\"\/pt\/issuing\/account-structure-resources\/issuing-enterprise\/\">Issuing<\/a>, or <a href=\"\/pt\/payouts\/payout-service\/\">Payouts<\/a> integration.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong>API credentials<\/strong><\/td>\n<td style=\"text-align: left;\">You must have the credentials and the following roles for the  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/transfers\/latest\/overview\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">Transfers API<\/a>. Ensure that you have asked your Adyen contact to assign the following role to your API credential::<ul><li markdown=\"1\"><strong>TransferService Webservice Retrieve role<\/strong> role<li markdown=\"1\">Transfers must also be enabled for the source balance account.<\/li><\/ul><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h2>Use cases<\/h2>\n<p>By leveraging this API, you can monitor and manage both internal and external transfers efficiently, ensuring accurate record keeping. Examples of these types of transfers are:<\/p>\n<ul>\n<li>A payment from a purchase in your balance platform.<\/li>\n<li>A payout to one of your users.\n<\/li>\n<\/ul>\n<p>With the Transactions API, you can query the transactions for your whole balance platform, a particular account holder, or balance account.<\/p>\n<h2>Get a list of transactions<\/h2>\n<p>To get a list of transactions, related to a balance account, account holder, or balance platform:<\/p>\n<ol>\n<li>\n<p>Make a GET&nbsp; <a href=\"https:\/\/docs.adyen.com\/api-explorer\/transfers\/latest\/get\/transactions\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">\/transactions<\/a> request with the following query parameters.<\/p>\n<table>\n<thead>\n<tr>\n<th style=\"text-align: left;\">Parameter<\/th>\n<th style=\"text-align: center;\">Required<\/th>\n<th style=\"text-align: left;\">Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td style=\"text-align: left;\"> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/transfers\/latest\/get\/transactions#query-balancePlatform\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">balancePlatform<\/a>,  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/transfers\/latest\/get\/transactions#query-accountHolderId\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">accountHolderId<\/a>, or  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/transfers\/latest\/get\/transactions#query-balanceAccountId\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">balanceAccountId<\/a><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: left;\">You must include at least one of the following in your request: <ul><li markdown=\"1\"> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/transfers\/latest\/get\/transactions#query-balancePlatform\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">balancePlatform<\/a>: The unique identifier of the balance platform.<\/li> <li markdown=\"1\"> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/transfers\/latest\/get\/transactions#query-accountHolderId\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">accountHolderId<\/a>: The unique identifier of the account holder.<\/li><li markdown=\"1\"> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/transfers\/latest\/get\/transactions#query-balanceAccountId\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">balanceAccountId<\/a>: The unique identifier of the balance account.<\/li><\/ul><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/transfers\/latest\/get\/transactions#query-createdSince\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">createdSince<\/a><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: left;\">Transactions created after this date and time are included in the response. The value must be in <a href=\"https:\/\/www.w3.org\/TR\/NOTE-datetime\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">ISO 8601<\/a> format. For example, <strong>2021-05-30T15:07:40Z<\/strong>.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/transfers\/latest\/get\/transactions#query-createdUntil\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">createdUntil<\/a><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: left;\">Transactions created before this date and time are included in the response. The value must be in <a href=\"https:\/\/www.w3.org\/TR\/NOTE-datetime\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">ISO 8601<\/a> format. For example, <strong>2021-05-30T15:07:40Z<\/strong>.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/transfers\/latest\/get\/transactions#query-limit\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">limit<\/a><\/td>\n<td style=\"text-align: center;\"><\/td>\n<td style=\"text-align: left;\">The number of items returned per page.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/transfers\/latest\/get\/transactions#query-sortOrder\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">sortOrder<\/a><\/td>\n<td style=\"text-align: center;\"><\/td>\n<td style=\"text-align: left;\">The transactions sorting order.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/transfers\/latest\/get\/transactions#query-cursor\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">cursor<\/a><\/td>\n<td style=\"text-align: center;\"><\/td>\n<td style=\"text-align: left;\">The cursor returned in the <code>links<\/code> of the previous response.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/transfers\/latest\/get\/transactions#query-paymentInstrumentId\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">paymentInstrumentId<\/a><\/td>\n<td style=\"text-align: center;\"><\/td>\n<td style=\"text-align: left;\">The unique identifier of the payment instrument.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<div data-component-wrapper=\"code-sample\">\n<code-sample :title=\"'Example GET \/transactions request'\" :id=\"'get-transactions'\" :code-data=\"[{&quot;language&quot;:&quot;bash&quot;,&quot;tabTitle&quot;:&quot;curl&quot;,&quot;content&quot;:&quot;curl https:\\\/\\\/balanceplatform-api-test.adyen.com\\\/btl\\\/v4\\\/transactions?accountHolderId=AH00000000000000000000001&amp;createdUntil=2021-10-05&amp;limit=4&amp;accountHolder&amp;createdSince=2015-10-01 \\\\\\n-H 'x-api-key: ADYEN_BALANCE_PLATFORM_API_KEY' \\\\\\n-H 'content-type: application\\\/json' \\\\\\n-X GET \\\\\\n-d ''&quot;},{&quot;language&quot;:&quot;java&quot;,&quot;tabTitle&quot;:&quot;Java&quot;,&quot;content&quot;:&quot;\\\/\\\/ Adyen Java API Library v33.0.0\\nimport com.adyen.Client;\\nimport com.adyen.enums.Environment;\\nimport com.adyen.model.transfers.*;\\nimport java.time.OffsetDateTime;\\nimport java.util.*;\\nimport com.adyen.service.transfers.*;\\n\\nClient client = new Client(\\&quot;ADYEN_BALANCE_PLATFORM_API_KEY\\&quot;, Environment.TEST);\\n\\\/\\\/ Send the request\\nTransactionsApi service = new TransactionsApi(client);\\nTransactionSearchResponse response = service.getAllTransactions(\\&quot;String\\&quot;, \\&quot;String\\&quot;, \\&quot;String\\&quot;, \\&quot;String\\&quot;, \\&quot;String\\&quot;, LocalDateTime.parse(\\&quot;2025-01-01T15:00:00\\&quot;);, LocalDateTime.parse(\\&quot;2025-01-01T15:00:00\\&quot;);, 1, null);&quot;},{&quot;language&quot;:&quot;php&quot;,&quot;tabTitle&quot;:&quot;PHP&quot;,&quot;content&quot;:&quot;&lt;?php\\n\\\/\\\/ Adyen PHP API Library v24.0.0\\nuse Adyen\\\\Client;\\nuse Adyen\\\\Environment;\\nuse Adyen\\\\Service\\\\Transfers\\\\TransactionsApi;\\n\\n$client = new Client();\\n$client-&gt;setXApiKey(\\&quot;ADYEN_BALANCE_PLATFORM_API_KEY\\&quot;);\\n$client-&gt;setEnvironment(Environment::TEST);\\n\\n$requestOptions['queryParams'] = array('balancePlatform' =&gt; 'string', 'paymentInstrumentId' =&gt; 'string', 'accountHolderId' =&gt; 'string', 'balanceAccountId' =&gt; 'string', 'cursor' =&gt; 'string', 'createdSince' =&gt; 'date-time', 'createdUntil' =&gt; 'date-time', 'limit' =&gt; 'integer');\\n\\n\\\/\\\/ Send the request\\n$service = new TransactionsApi($client);\\n$response = $service-&gt;getAllTransactions($requestOptions);&quot;},{&quot;language&quot;:&quot;cs&quot;,&quot;tabTitle&quot;:&quot;C#&quot;,&quot;content&quot;:&quot;\\\/\\\/ Adyen .net API Library v27.0.0\\nusing Adyen;\\nusing Environment = Adyen.Model.Environment;\\nusing Adyen.Model;\\nusing Adyen.Model.Transfers;\\nusing Adyen.Service.Transfers;\\n\\nvar config = new Config()\\n{\\n    XApiKey = \\&quot;ADYEN_BALANCE_PLATFORM_API_KEY\\&quot;,\\n    Environment = Environment.Test\\n};\\nvar client = new Client(config);\\n\\n\\\/\\\/ Send the request\\nvar service = new TransactionsService(client);\\nvar response = service.GetAllTransactions(balancePlatform: \\&quot;string\\&quot;, paymentInstrumentId: \\&quot;string\\&quot;, accountHolderId: \\&quot;string\\&quot;, balanceAccountId: \\&quot;string\\&quot;, cursor: \\&quot;string\\&quot;, createdSince: DateTime.Parse(\\&quot;2025-01-01T15:00:00\\&quot;), createdUntil: DateTime.Parse(\\&quot;2025-01-01T15:00:00\\&quot;), limit: 1);&quot;},{&quot;language&quot;:&quot;js&quot;,&quot;tabTitle&quot;:&quot;NodeJS (JavaScript)&quot;,&quot;content&quot;:&quot;\\\/\\\/ Adyen Node API Library v23.3.0\\nconst { Client, TransfersAPI } = require('@adyen\\\/api-library');\\n\\nconst client = new Client({ apiKey: \\&quot;ADYEN_BALANCE_PLATFORM_API_KEY\\&quot;, environment: \\&quot;TEST\\&quot; });\\n\\n\\\/\\\/ Send the request\\nconst transfersAPI = new TransfersAPI(client);\\nconst response = transfersAPI.TransactionsApi.getAllTransactions(\\&quot;string\\&quot;, \\&quot;string\\&quot;, \\&quot;string\\&quot;, \\&quot;string\\&quot;, \\&quot;string\\&quot;, Date.now(), Date.now(), 1);&quot;},{&quot;language&quot;:&quot;go&quot;,&quot;tabTitle&quot;:&quot;Go&quot;,&quot;content&quot;:&quot;\\\/\\\/ Adyen Go API Library v16.3.0\\nimport (\\n  \\&quot;context\\&quot;\\n  \\&quot;github.com\\\/adyen\\\/adyen-go-api-library\\\/v16\\\/src\\\/common\\&quot;\\n  \\&quot;github.com\\\/adyen\\\/adyen-go-api-library\\\/v16\\\/src\\\/adyen\\&quot;\\n  \\&quot;github.com\\\/adyen\\\/adyen-go-api-library\\\/v16\\\/src\\\/transfers\\&quot;\\n)\\nclient := adyen.NewClient(&amp;common.Config{\\n  ApiKey:      \\&quot;ADYEN_BALANCE_PLATFORM_API_KEY\\&quot;,\\n  Environment: common.TestEnv,\\n})\\n\\n\\\/\\\/ Send the request\\nservice := client.Transfers()\\nreq := service.TransactionsApi.GetAllTransactionsInput()\\nreq = req.BalancePlatform(\\&quot;string\\&quot;).PaymentInstrumentId(\\&quot;string\\&quot;).AccountHolderId(\\&quot;string\\&quot;).BalanceAccountId(\\&quot;string\\&quot;).Cursor(\\&quot;string\\&quot;).CreatedSince(DateTime.Parse(\\&quot;2025-01-01T15:00:00\\&quot;)).CreatedUntil(DateTime.Parse(\\&quot;2025-01-01T15:00:00\\&quot;)).Limit(1)\\nres, httpRes, err := service.TransactionsApi.GetAllTransactions(context.Background(), req)&quot;},{&quot;language&quot;:&quot;py&quot;,&quot;tabTitle&quot;:&quot;Python&quot;,&quot;content&quot;:&quot;# Adyen Python API Library v13.3.0\\nimport Adyen\\n\\nadyen = Adyen.Adyen()\\nadyen.client.xapikey = \\&quot;ADYEN_BALANCE_PLATFORM_API_KEY\\&quot;\\nadyen.client.platform = \\&quot;test\\&quot; # The environment to use library in.\\n\\nquery_parameters = {\\n  \\&quot;balancePlatform\\&quot; : \\&quot;string\\&quot;,\\n  \\&quot;paymentInstrumentId\\&quot; : \\&quot;string\\&quot;,\\n  \\&quot;accountHolderId\\&quot; : \\&quot;string\\&quot;,\\n  \\&quot;balanceAccountId\\&quot; : \\&quot;string\\&quot;,\\n  \\&quot;cursor\\&quot; : \\&quot;string\\&quot;,\\n  \\&quot;createdSince\\&quot; : \\&quot;date-time\\&quot;,\\n  \\&quot;createdUntil\\&quot; : \\&quot;date-time\\&quot;,\\n  \\&quot;limit\\&quot; : \\&quot;integer\\&quot;\\n}\\n\\n# Send the request\\nresult = adyen.transfers.transactions_api.get_all_transactions(query_parameters=query_parameters)&quot;},{&quot;language&quot;:&quot;rb&quot;,&quot;tabTitle&quot;:&quot;Ruby&quot;,&quot;content&quot;:&quot;# Adyen Ruby API Library v10.1.1\\nrequire \\&quot;adyen-ruby-api-library\\&quot;\\n\\nadyen = Adyen::Client.new\\nadyen.api_key = 'ADYEN_BALANCE_PLATFORM_API_KEY'\\nadyen.env = :test # Set to \\&quot;live\\&quot; for live environment\\n\\n# Create the request object(s)\\nquery_params = {\\n  :balancePlatform =&gt; 'string',\\n  :paymentInstrumentId =&gt; 'string',\\n  :accountHolderId =&gt; 'string',\\n  :balanceAccountId =&gt; 'string',\\n  :cursor =&gt; 'string',\\n  :createdSince =&gt; 'date-time',\\n  :createdUntil =&gt; 'date-time',\\n  :limit =&gt; 'integer'\\n}\\n\\n# Send the request\\nresult = adyen.transfers.transactions_api.get_all_transactions(query_params: query_params)&quot;},{&quot;language&quot;:&quot;ts&quot;,&quot;tabTitle&quot;:&quot;NodeJS (TypeScript)&quot;,&quot;content&quot;:&quot;\\\/\\\/ Adyen Node API Library v23.3.0\\nimport { Client, TransfersAPI, Types } from \\&quot;@adyen\\\/api-library\\&quot;;\\n\\nconst client = new Client({ apiKey: \\&quot;ADYEN_BALANCE_PLATFORM_API_KEY\\&quot;, environment: \\&quot;TEST\\&quot; });\\n\\n\\\/\\\/ Send the request\\nconst transfersAPI = new TransfersAPI(client);\\nconst response = transfersAPI.TransactionsApi.getAllTransactions(\\&quot;string\\&quot;, \\&quot;string\\&quot;, \\&quot;string\\&quot;, \\&quot;string\\&quot;, \\&quot;string\\&quot;, Date.now(), Date.now(), 1);&quot;}]\" :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<\/li>\n<li>\n<p>The response includes:<\/p>\n<ul>\n<li><code>data<\/code>: an array containing all the transactions that match the query parameters.<\/li>\n<li><code>_links<\/code>: an object containing links to the next or previous page when applicable. To page through the results, add the <code>cursor<\/code> value as a query parameter in your next request.<\/li>\n<\/ul>\n<div data-component-wrapper=\"code-sample\">\n<code-sample :title=\"'Example GET \/transactions response'\" :id=\"'get-transaction-response'\" :code-data=\"[{&quot;language&quot;:&quot;json&quot;,&quot;tabTitle&quot;:&quot;&quot;,&quot;content&quot;:&quot;{\\n    \\&quot;data\\&quot;: [\\n        {\\n            \\&quot;balancePlatform\\&quot;: \\&quot;YOUR_BALANCE_PLATFORM\\&quot;,\\n            \\&quot;creationDate\\&quot;: \\&quot;2023-08-10T14:51:20+02:00\\&quot;,\\n            \\&quot;description\\&quot;: \\&quot;Your description for the payout\\&quot;,\\n            \\&quot;id\\&quot;: \\&quot;EVJN42272224222B5JB8BRC84N686ZEUR\\&quot;,\\n            \\&quot;accountHolder\\&quot;: {\\n                \\&quot;description\\&quot;: \\&quot;Your description for the account holder\\&quot;,\\n                \\&quot;id\\&quot;: \\&quot;AH00000000000000000000001\\&quot;\\n            },\\n            \\&quot;amount\\&quot;: {\\n                \\&quot;currency\\&quot;: \\&quot;USD\\&quot;,\\n                \\&quot;value\\&quot;: -1000\\n            },\\n            \\&quot;balanceAccount\\&quot;: {\\n                \\&quot;description\\&quot;: \\&quot;Your description for the account holder\\&quot;,\\n                \\&quot;id\\&quot;: \\&quot;BA00000000000000000000001\\&quot;\\n            },\\n            \\&quot;bookingDate\\&quot;: \\&quot;2023-08-10T14:51:33+02:00\\&quot;,\\n            \\&quot;status\\&quot;: \\&quot;booked\\&quot;,\\n            \\&quot;transfer\\&quot;: {\\n                \\&quot;categoryData\\&quot;: {\\n                    \\&quot;priority\\&quot;: \\&quot;regular\\&quot;,\\n                    \\&quot;type\\&quot;: \\&quot;bank\\&quot;\\n                },\\n                \\&quot;id\\&quot;: \\&quot;3JNC3O5ZVFLLGV4B\\&quot;,\\n                \\&quot;reference\\&quot;: \\&quot;Your internal reference for the transfer\\&quot;\\n            },\\n            \\&quot;referenceForBeneficiary\\&quot;: \\&quot;Your reference sent to the beneficiary\\&quot;,\\n            \\&quot;valueDate\\&quot;: \\&quot;2023-08-10T14:51:20+02:00\\&quot;\\n        },\\n        {\\n            \\&quot;balancePlatform\\&quot;: \\&quot;YOUR_BALANCE_PLATFORM\\&quot;,\\n            \\&quot;creationDate\\&quot;: \\&quot;2023-08-10T15:34:31+02:00\\&quot;,\\n            \\&quot;description\\&quot;: \\&quot;Your description for the transfer\\&quot;,\\n            \\&quot;id\\&quot;: \\&quot;EVJN4227C224222B5JB8G3Q89N2NB6EUR\\&quot;,\\n            \\&quot;accountHolder\\&quot;: {\\n                \\&quot;description\\&quot;: \\&quot;Your description for the account holder\\&quot;,\\n                \\&quot;id\\&quot;: \\&quot;AH00000000000000000000001\\&quot;\\n            },\\n            \\&quot;amount\\&quot;: {\\n                \\&quot;currency\\&quot;: \\&quot;USD\\&quot;,\\n                \\&quot;value\\&quot;: 123\\n            },\\n            \\&quot;balanceAccount\\&quot;: {\\n                \\&quot;description\\&quot;: \\&quot;Your description for the account holder\\&quot;,\\n                \\&quot;id\\&quot;: \\&quot;BA00000000000000000000001\\&quot;\\n            },\\n            \\&quot;bookingDate\\&quot;: \\&quot;2023-08-10T15:34:40+02:00\\&quot;,\\n            \\&quot;status\\&quot;: \\&quot;booked\\&quot;,\\n            \\&quot;transfer\\&quot;: {\\n                \\&quot;id\\&quot;: \\&quot;48POO45ZVG11166J\\&quot;,\\n                \\&quot;reference\\&quot;: \\&quot;Your internal reference for the transfer\\&quot;\\n            },\\n            \\&quot;valueDate\\&quot;: \\&quot;2023-08-10T15:34:31+02:00\\&quot;\\n        },\\n        {\\n            \\&quot;balancePlatform\\&quot;: \\&quot;YOUR_BALANCE_PLATFORM\\&quot;,\\n            \\&quot;creationDate\\&quot;: \\&quot;2023-08-11T13:45:46+02:00\\&quot;,\\n            \\&quot;description\\&quot;:\\&quot;Your description for the transfer\\&quot;,\\n            \\&quot;id\\&quot;: \\&quot;EVJN4227C224222B5JBD3XHF8P3L8GUSD\\&quot;,\\n            \\&quot;accountHolder\\&quot;: {\\n                \\&quot;description\\&quot;: \\&quot;Your description for the account holder\\&quot;,\\n                \\&quot;id\\&quot;: \\&quot;AH00000000000000000000001\\&quot;\\n            },\\n            \\&quot;amount\\&quot;: {\\n                \\&quot;currency\\&quot;: \\&quot;USD\\&quot;,\\n                \\&quot;value\\&quot;: -10000\\n            },\\n            \\&quot;balanceAccount\\&quot;: {\\n                \\&quot;description\\&quot;: \\&quot;Your description for the account holder\\&quot;,\\n                \\&quot;id\\&quot;: \\&quot;BA00000000000000000000001\\&quot;\\n            },\\n            \\&quot;bookingDate\\&quot;: \\&quot;2023-08-11T13:45:57+02:00\\&quot;,\\n            \\&quot;status\\&quot;: \\&quot;booked\\&quot;,\\n            \\&quot;transfer\\&quot;: {\\n                \\&quot;categoryData\\&quot;: {\\n                    \\&quot;priority\\&quot;: \\&quot;internal\\&quot;,\\n                    \\&quot;type\\&quot;: \\&quot;internalTransfer\\&quot;\\n                },\\n                \\&quot;id\\&quot;: \\&quot;48RTTW5ZVT8KU9DV\\&quot;,\\n                \\&quot;reference\\&quot;: \\&quot;The sender's reference for the transfer\\&quot;\\n            },\\n            \\&quot;valueDate\\&quot;: \\&quot;2023-08-11T13:45:46+02:00\\&quot;\\n        },\\n        {\\n            \\&quot;balancePlatform\\&quot;: \\&quot;YOUR_BALANCE_PLATFORM\\&quot;,\\n            \\&quot;creationDate\\&quot;: \\&quot;2023-08-11T13:45:51+02:00\\&quot;,\\n            \\&quot;description\\&quot;: \\&quot;The sender's description for the transfer\\&quot;,\\n            \\&quot;id\\&quot;: \\&quot;EVJN42272224222B5JBD3XJGHF4J26USD\\&quot;,\\n            \\&quot;accountHolder\\&quot;: {\\n                \\&quot;description\\&quot;: \\&quot;Your description for the account holder\\&quot;,\\n                \\&quot;id\\&quot;: \\&quot;AH00000000000000000000001\\&quot;\\n            },\\n            \\&quot;amount\\&quot;: {\\n                \\&quot;currency\\&quot;: \\&quot;USD\\&quot;,\\n                \\&quot;value\\&quot;: 1000\\n            },\\n            \\&quot;balanceAccount\\&quot;: {\\n                \\&quot;description\\&quot;: \\&quot;Your description for the account holder\\&quot;,\\n                \\&quot;id\\&quot;: \\&quot;BA00000000000000000000001\\&quot;\\n            },\\n            \\&quot;bookingDate\\&quot;: \\&quot;2023-08-11T13:45:58+02:00\\&quot;,\\n            \\&quot;status\\&quot;: \\&quot;booked\\&quot;,\\n            \\&quot;transfer\\&quot;: {\\n                \\&quot;id\\&quot;: \\&quot;48TYZO5ZVT8M1K47\\&quot;,\\n                \\&quot;reference\\&quot;: \\&quot;The sender's reference for the transfer\\&quot;\\n            },\\n            \\&quot;valueDate\\&quot;: \\&quot;2023-08-11T13:45:51+02:00\\&quot;\\n        }\\n    ],\\n    \\&quot;_links\\&quot;: {\\n        \\&quot;next\\&quot;: {\\n            \\&quot;href\\&quot;: \\&quot;https:\\\/\\\/balanceplatform-api-test.adyen.com\\\/btl\\\/v4\\\/transactions?balancePlatform=TestBalancePlatform&amp;createdUntil=2023-08-20T13%3A07%3A40Z&amp;createdSince=2023-08-10T10%3A50%3A40Z&amp;cursor=S2B-c0p1N0tdN0l6RGhYK1YpM0lgOTUyMDlLXElyKE9LMCtyaFEuMj1NMHgidCsrJi1ZNnhqXCtqVi5JPGpRK1F2fCFqWzU33JTojSVNJc1J1VXhncS10QDd6JX9FQFl5Zn0uNyUvSXJNQTo\\&quot;\\n        }\\n    }\\n}&quot;}]\" :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<\/li>\n<li>\n<p>If you only want to get details of a particular transaction, include the <code>transactionId<\/code> in your GET&nbsp; <a href=\"https:\/\/docs.adyen.com\/api-explorer\/transfers\/latest\/get\/transactions\/(id)\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">\/transactions\/{id}<\/a> request.<\/p>\n<\/li>\n<\/ol>\n<h2 id=\"incoming-and-outgoing-funds\">Identify incoming and outgoing funds<\/h2>\n<p>Refer to the following fields and objects of the API response to find out if a transaction is outgoing or incoming.<\/p>\n<table>\n<thead>\n<tr>\n<th style=\"text-align: left;\">Field<\/th>\n<th style=\"text-align: left;\">Incoming funds<\/th>\n<th style=\"text-align: left;\">Outgoing funds<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td style=\"text-align: left;\"> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/transfers\/latest\/get\/transactions\/#responses-200-data-amount\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">amount<\/a><\/td>\n<td style=\"text-align: left;\">Has a positive  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/transfers\/latest\/get\/transactions\/#responses-200-data-amount-value\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">value<\/a>, meaning funds are added to the balance account.<\/td>\n<td style=\"text-align: left;\">Has a negative  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/transfers\/latest\/get\/transactions\/#responses-200-data-amount-value\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">value<\/a>, meaning funds are deducted from the balance account.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/transfers\/latest\/get\/transactions\/#responses-200-data-transfer-reference\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">\/data.transfer.reference<\/a><\/td>\n<td style=\"text-align: left;\">The reference from the sender, if they sent any.<\/td>\n<td style=\"text-align: left;\">The reference that you sent in the <code>\/transfers<\/code> request.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/transfers\/latest\/get\/transactions\/#responses-200-data-status\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">status<\/a><\/td>\n<td style=\"text-align: left;\">The status of the transaction. It can be: <br><ul><li markdown=\"1\"><strong>pending<\/strong>: The funds have not been added yet to the balance account. Check the   <a href=\"https:\/\/docs.adyen.com\/api-explorer\/transfers\/latest\/get\/transactions\/#responses-200-data-valueDate\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">valueDate<\/a> to know when the funds will be available.<\/li><li markdown=\"1\"><strong>booked<\/strong>: The funds have been added to the balance account.<\/li><\/ul><\/td>\n<td style=\"text-align: left;\">The status of the transaction. It can be: <br><ul><li markdown=\"1\"><strong>pending<\/strong>: The funds are reserved to be deducted from the balance account. Check the  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/transfers\/latest\/get\/transactions\/#responses-200-data-valueDate\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">valueDate<\/a> to know when the funds will be deducted.<\/li><li markdown=\"1\"><strong>booked<\/strong>: The funds have been deducted from the balance account.<\/li><\/ul><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<p>Both incoming and outgoing transactions can be a result of <a href=\"#external-transactions\">external<\/a> or <a href=\"#internal-transactions\">internal<\/a> transfers. The following subsections show example responses for external and internal transactions<\/p>\n<h3>External transactions<\/h3>\n<p>These transactions result from paying out funds to third-party <a href=\"\/pt\/payouts\/payout-service\/pay-out-to-bank-accounts\">bank account<\/a> or <a href=\"\/pt\/payouts\/payout-service\/pay-out-to-cards\">card<\/a>. The following shows an example response that you would get for an outgoing external transactions.<\/p>\n<div data-component-wrapper=\"code-sample\">\n    <code-sample :title=\"'Outgoing external transaction'\" :id=\"'outgoing-external-transaction'\" :code-data='[{\"language\":\"json\",\"tabTitle\":\"\",\"content\":\"{\\n    \\\"id\\\": \\\"EVJN00000000000000000000000002EUR\\\",\\n    \\\"amount\\\": {\\n        \\\"value\\\": -10000,\\n        \\\"currency\\\": \\\"EUR\\\"\\n    },\\n    \\\"status\\\": \\\"booked\\\",\\n    \\\"transfer\\\": {\\n        \\\"categoryData\\\": {\\n            \\\"priority\\\": \\\"regular\\\",\\n            \\\"type\\\": \\\"bank\\\"\\n        },\\n        \\\"id\\\": \\\"48TYZO5ZVURJ2FCW\\\",\\n        \\\"reference\\\": \\\"Your internal reference for the transfer\\\"\\n    },\\n    \\\"valueDate\\\": \\\"2023-08-11T16:19:35+02:00\\\",\\n    \\\"bookingDate\\\": \\\"2023-08-11T16:19:39+02:00\\\",\\n    \\\"creationDate\\\": \\\"2023-08-11T16:19:35+02:00\\\",\\n    \\\"description\\\": \\\"Your description of the transfer\\\",\\n    \\\"referenceForBeneficiary\\\": \\\"Your reference for the beneficiary of the transfer\\\",\\n    \\\"accountHolder\\\": {\\n        \\\"id\\\": \\\"AH00000000000000000000001\\\",\\n        \\\"description\\\": \\\"Your description of the account holder\\\"\\n    },\\n    \\\"balanceAccount\\\": {\\n        \\\"id\\\": \\\"BA00000000000000000000001\\\",\\n        \\\"description\\\": \\\"Your description of the balance account\\\"\\n    },\\n    \\\"balancePlatform\\\": \\\"YOUR_BALANCE_PLATFORM\\\"\\n}\"}]' :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<h3>Internal transactions<\/h3>\n<p>These transactions result from <a href=\"\/pt\/payouts\/payout-service\/internal-fund-transfers\">internal transfers<\/a> between balance accounts. The following tabs show example responses that you would get when making a request to get incoming or outgoing internal transactions.<\/p>\n\n<div id=\"tabW1QdP\">\n    <div data-component-wrapper=\"tabs\">\n        <tabs\n                        :items=\"[{&quot;title&quot;:&quot;Example of an outgoing internal transaction&quot;,&quot;content&quot;:&quot;\\n&lt;p&gt;After making a successful GET&amp;nbsp; &lt;a href=\\&quot;https:\\\/\\\/docs.adyen.com\\\/api-explorer\\\/transfers\\\/latest\\\/get\\\/transactions\\&quot; class=\\&quot;codeLabel  external-link no-image\\&quot; target=\\&quot;_blank\\&quot; rel=\\&quot;nofollow noopener noreferrer\\&quot;&gt;\\\/transactions&lt;\\\/a&gt; or GET&amp;nbsp; &lt;a href=\\&quot;https:\\\/\\\/docs.adyen.com\\\/api-explorer\\\/transfers\\\/latest\\\/get\\\/transactions\\\/(id)\\&quot; class=\\&quot;codeLabel  external-link no-image\\&quot; target=\\&quot;_blank\\&quot; rel=\\&quot;nofollow noopener noreferrer\\&quot;&gt;\\\/transactions\\\/{id}&lt;\\\/a&gt; request, you get the following information:&lt;\\\/p&gt;\\n&lt;div data-component-wrapper=\\&quot;code-sample\\&quot;&gt;\\n    &lt;code-sample :title=\\&quot;&#039;Outgoing internal transaction&#039;\\&quot; :id=\\&quot;&#039;outgoing-internal-transaction&#039;\\&quot; :code-data=&#039;[{\\&quot;language\\&quot;:\\&quot;json\\&quot;,\\&quot;tabTitle\\&quot;:\\&quot;\\&quot;,\\&quot;content\\&quot;:\\&quot;{\\\\n    \\\\\\&quot;id\\\\\\&quot;: \\\\\\&quot;EVJN00000000000000000000000002EUR\\\\\\&quot;,\\\\n    \\\\\\&quot;amount\\\\\\&quot;: {\\\\n        \\\\\\&quot;value\\\\\\&quot;: -10000,\\\\n        \\\\\\&quot;currency\\\\\\&quot;: \\\\\\&quot;EUR\\\\\\&quot;\\\\n    },\\\\n    \\\\\\&quot;status\\\\\\&quot;: \\\\\\&quot;booked\\\\\\&quot;,\\\\n    \\\\\\&quot;transfer\\\\\\&quot;: {\\\\n        \\\\\\&quot;categoryData\\\\\\&quot;: {\\\\n            \\\\\\&quot;type\\\\\\&quot;: \\\\\\&quot;internal\\\\\\&quot;\\\\n        },\\\\n        \\\\\\&quot;id\\\\\\&quot;: \\\\\\&quot;48TYZO5ZVURJ2FCW\\\\\\&quot;,\\\\n        \\\\\\&quot;reference\\\\\\&quot;: \\\\\\&quot;Your internal reference for the transfer\\\\\\&quot;\\\\n    },\\\\n    \\\\\\&quot;valueDate\\\\\\&quot;: \\\\\\&quot;2023-08-11T16:19:35+02:00\\\\\\&quot;,\\\\n    \\\\\\&quot;bookingDate\\\\\\&quot;: \\\\\\&quot;2023-08-11T16:19:39+02:00\\\\\\&quot;,\\\\n    \\\\\\&quot;creationDate\\\\\\&quot;: \\\\\\&quot;2023-08-11T16:19:35+02:00\\\\\\&quot;,\\\\n    \\\\\\&quot;description\\\\\\&quot;: \\\\\\&quot;Your description of the transfer\\\\\\&quot;,\\\\n    \\\\\\&quot;referenceForBeneficiary\\\\\\&quot;: \\\\\\&quot;Your reference for the beneficiary\\\\\\&quot;,\\\\n    \\\\\\&quot;accountHolder\\\\\\&quot;: {\\\\n        \\\\\\&quot;id\\\\\\&quot;: \\\\\\&quot;AH00000000000000000000001\\\\\\&quot;,\\\\n        \\\\\\&quot;description\\\\\\&quot;: \\\\\\&quot;Your description of the account holder\\\\\\&quot;\\\\n    },\\\\n    \\\\\\&quot;balanceAccount\\\\\\&quot;: {\\\\n        \\\\\\&quot;id\\\\\\&quot;: \\\\\\&quot;BA00000000000000000000001\\\\\\&quot;,\\\\n        \\\\\\&quot;description\\\\\\&quot;: \\\\\\&quot;Your description of the balance account\\\\\\&quot;\\\\n    },\\\\n    \\\\\\&quot;balancePlatform\\\\\\&quot;: \\\\\\&quot;YOUR_BALANCE_PLATFORM\\\\\\&quot;\\\\n}\\&quot;}]&#039; :enable-copy-link-to-code-block=\\&quot;true\\&quot; :code-sample-card-size=\\&quot;&#039;fullsize&#039;\\&quot;&gt;&lt;\\\/code-sample&gt;\\n&lt;\\\/div&gt;\\n&quot;,&quot;altTitle&quot;:null,&quot;oldTabId&quot;:&quot;example_of_an_outgoing_internal_transaction_0_1&quot;,&quot;relation&quot;:&quot;&quot;},{&quot;title&quot;:&quot;Example of an incoming internal transaction&quot;,&quot;content&quot;:&quot;\\n&lt;p&gt;After making a successful GET&amp;nbsp; &lt;a href=\\&quot;https:\\\/\\\/docs.adyen.com\\\/api-explorer\\\/transfers\\\/latest\\\/get\\\/transactions\\&quot; class=\\&quot;codeLabel  external-link no-image\\&quot; target=\\&quot;_blank\\&quot; rel=\\&quot;nofollow noopener noreferrer\\&quot;&gt;\\\/transactions&lt;\\\/a&gt; or GET&amp;nbsp; &lt;a href=\\&quot;https:\\\/\\\/docs.adyen.com\\\/api-explorer\\\/transfers\\\/latest\\\/get\\\/transactions\\\/(id)\\&quot; class=\\&quot;codeLabel  external-link no-image\\&quot; target=\\&quot;_blank\\&quot; rel=\\&quot;nofollow noopener noreferrer\\&quot;&gt;\\\/transactions\\\/{id}&lt;\\\/a&gt; request, you get the following information:&lt;\\\/p&gt;\\n&lt;div data-component-wrapper=\\&quot;code-sample\\&quot;&gt;\\n    &lt;code-sample :title=\\&quot;&#039;Incoming internal transaction&#039;\\&quot; :id=\\&quot;&#039;incoming-internal-transaction&#039;\\&quot; :code-data=\\&quot;[{&amp;quot;language&amp;quot;:&amp;quot;json&amp;quot;,&amp;quot;tabTitle&amp;quot;:&amp;quot;&amp;quot;,&amp;quot;content&amp;quot;:&amp;quot;{\\\\n    \\\\&amp;quot;id\\\\&amp;quot;: \\\\&amp;quot;EVJN00000000000000000000000001EUR\\\\&amp;quot;,\\\\n    \\\\&amp;quot;amount\\\\&amp;quot;: {\\\\n        \\\\&amp;quot;value\\\\&amp;quot;: 10000,\\\\n        \\\\&amp;quot;currency\\\\&amp;quot;: \\\\&amp;quot;EUR\\\\&amp;quot;\\\\n    },\\\\n    \\\\&amp;quot;status\\\\&amp;quot;: \\\\&amp;quot;booked\\\\&amp;quot;,\\\\n    \\\\&amp;quot;transfer\\\\&amp;quot;: {\\\\n        \\\\&amp;quot;categoryData\\\\&amp;quot;: {\\\\n            \\\\&amp;quot;type\\\\&amp;quot;: \\\\&amp;quot;internal\\\\&amp;quot;\\\\n        },\\\\n        \\\\&amp;quot;id\\\\&amp;quot;: \\\\&amp;quot;3JW8PC5ZVV06067J\\\\&amp;quot;,\\\\n        \\\\&amp;quot;reference\\\\&amp;quot;: \\\\&amp;quot;An internal reference for the transfer\\\\&amp;quot;\\\\n    },\\\\n    \\\\&amp;quot;valueDate\\\\&amp;quot;: \\\\&amp;quot;2023-08-11T16:19:35+02:00\\\\&amp;quot;,\\\\n    \\\\&amp;quot;bookingDate\\\\&amp;quot;: \\\\&amp;quot;2023-08-11T16:43:46+02:00\\\\&amp;quot;,\\\\n    \\\\&amp;quot;creationDate\\\\&amp;quot;: \\\\&amp;quot;2023-08-11T16:43:46+02:00\\\\&amp;quot;,\\\\n    \\\\&amp;quot;description\\\\&amp;quot;: \\\\&amp;quot;The sender&#039;s description of the transfer\\\\&amp;quot;,\\\\n    \\\\&amp;quot;referenceForBeneficiary\\\\&amp;quot;: \\\\&amp;quot;The sender&#039;s reference for the beneficiary\\\\&amp;quot;,\\\\n    \\\\&amp;quot;accountHolder\\\\&amp;quot;: {\\\\n        \\\\&amp;quot;id\\\\&amp;quot;: \\\\&amp;quot;AH00000000000000000000001\\\\&amp;quot;,\\\\n        \\\\&amp;quot;description\\\\&amp;quot;: \\\\&amp;quot;Your description of the account holder\\\\&amp;quot;\\\\n    },\\\\n    \\\\&amp;quot;balanceAccount\\\\&amp;quot;: {\\\\n        \\\\&amp;quot;id\\\\&amp;quot;: \\\\&amp;quot;BA00000000000000000000001\\\\&amp;quot;,\\\\n        \\\\&amp;quot;description\\\\&amp;quot;: \\\\&amp;quot;Your description of the balance account\\\\&amp;quot;\\\\n    },\\\\n    \\\\&amp;quot;balancePlatform\\\\&amp;quot;: \\\\&amp;quot;YOUR_BALANCE_PLATFORM\\\\&amp;quot;\\\\n}&amp;quot;}]\\&quot; :enable-copy-link-to-code-block=\\&quot;true\\&quot; :code-sample-card-size=\\&quot;&#039;fullsize&#039;\\&quot;&gt;&lt;\\\/code-sample&gt;\\n&lt;\\\/div&gt;\\n&quot;,&quot;altTitle&quot;:null,&quot;oldTabId&quot;:&quot;example_of_an_incoming_internal_transaction_1_2&quot;,&quot;relation&quot;:&quot;&quot;}]\"\n            :should-update-when-url-changes='false'>\n        <\/tabs>\n    <\/div>\n<\/div>\n\n<h2 id=\"booking-and-value-date\">Booking and value dates<\/h2>\n<p>For every transaction returned in the API response, you receive two date fields: the  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/transfers\/latest\/get\/transactions\/#responses-200-data-bookingDate\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">bookingDate<\/a> and the  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/transfers\/latest\/get\/transactions\/#responses-200-data-valueDate\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">valueDate<\/a>.<\/p>\n<p>These fields indicate when the funds are recorded and when they are deducted from your balance account. For example, when you pay out to a third-party bank account after bank cutoff times, the funds are reserved but are not yet deducted. In this scenario, the dates will be:<\/p>\n<ul>\n<li> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/transfers\/latest\/get\/transactions\/#responses-200-data-bookingDate\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">bookingDate<\/a>: The date when the funds are recorded as reserved or pending in the balance account.<\/li>\n<li> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/transfers\/latest\/get\/transactions\/#responses-200-data-valueDate\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">valueDate<\/a>: The date when the funds are deducted from or made available in the balance account.<\/li>\n<\/ul>\n<p>Funds are always deducted at the booked stage for outgoing transfers.<\/p>","url":"https:\/\/docs.adyen.com\/pt\/payouts\/payout-service\/transfer-transactions","articleFields":{"description":"Use our API to get updates about transactions resulting from payouts.","feedback_component":true,"id":"25142904","type":"page","_expandable":{"operations":""},"status":"current","last_edit_on":"07-09-2023 13:26","parameters":{"integrationType":"payouts","directoryPath":"\/payouts\/payout-service","transferType":"payout","model":"payouts"}},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/payouts\/payout-service\/transfer-transactions","title":"Track transactions","content":"To keep track of funds movements in your balance platform, you can use the  Transfers API API. With this API, you can query the  \/transactions endpoint for your whole balance platform, a particular account holder, or balance account. On this page you can:\n\nGet updates through webhooks.\n\nMake API requests to keep track of transactions.\n\nRequirements\n\n\n\nRequirement\nDescription\n\n\n\n\nIntegration type\nYou must have an Adyen for Platforms, Issuing, or Payouts integration.\n\n\nAPI credentials\nYou must have the credentials and the following roles for the  Transfers API. Ensure that you have asked your Adyen contact to assign the following role to your API credential::TransferService Webservice Retrieve role roleTransfers must also be enabled for the source balance account.\n\n\n\nUse cases\nBy leveraging this API, you can monitor and manage both internal and external transfers efficiently, ensuring accurate record keeping. Examples of these types of transfers are:\n\nA payment from a purchase in your balance platform.\nA payout to one of your users.\n\n\nWith the Transactions API, you can query the transactions for your whole balance platform, a particular account holder, or balance account.\nGet a list of transactions\nTo get a list of transactions, related to a balance account, account holder, or balance platform:\n\n\nMake a GET&nbsp; \/transactions request with the following query parameters.\n\n\n\nParameter\nRequired\nDescription\n\n\n\n\n balancePlatform,  accountHolderId, or  balanceAccountId\n\nYou must include at least one of the following in your request:  balancePlatform: The unique identifier of the balance platform.  accountHolderId: The unique identifier of the account holder. balanceAccountId: The unique identifier of the balance account.\n\n\n createdSince\n\nTransactions created after this date and time are included in the response. The value must be in ISO 8601 format. For example, 2021-05-30T15:07:40Z.\n\n\n createdUntil\n\nTransactions created before this date and time are included in the response. The value must be in ISO 8601 format. For example, 2021-05-30T15:07:40Z.\n\n\n limit\n\nThe number of items returned per page.\n\n\n sortOrder\n\nThe transactions sorting order.\n\n\n cursor\n\nThe cursor returned in the links of the previous response.\n\n\n paymentInstrumentId\n\nThe unique identifier of the payment instrument.\n\n\n\n\n\n\n\n\nThe response includes:\n\ndata: an array containing all the transactions that match the query parameters.\n_links: an object containing links to the next or previous page when applicable. To page through the results, add the cursor value as a query parameter in your next request.\n\n\n\n\n\n\nIf you only want to get details of a particular transaction, include the transactionId in your GET&nbsp; \/transactions\/{id} request.\n\n\nIdentify incoming and outgoing funds\nRefer to the following fields and objects of the API response to find out if a transaction is outgoing or incoming.\n\n\n\nField\nIncoming funds\nOutgoing funds\n\n\n\n\n amount\nHas a positive  value, meaning funds are added to the balance account.\nHas a negative  value, meaning funds are deducted from the balance account.\n\n\n \/data.transfer.reference\nThe reference from the sender, if they sent any.\nThe reference that you sent in the \/transfers request.\n\n\n status\nThe status of the transaction. It can be: pending: The funds have not been added yet to the balance account. Check the   valueDate to know when the funds will be available.booked: The funds have been added to the balance account.\nThe status of the transaction. It can be: pending: The funds are reserved to be deducted from the balance account. Check the  valueDate to know when the funds will be deducted.booked: The funds have been deducted from the balance account.\n\n\n\nBoth incoming and outgoing transactions can be a result of external or internal transfers. The following subsections show example responses for external and internal transactions\nExternal transactions\nThese transactions result from paying out funds to third-party bank account or card. The following shows an example response that you would get for an outgoing external transactions.\n\n    \n\nInternal transactions\nThese transactions result from internal transfers between balance accounts. The following tabs show example responses that you would get when making a request to get incoming or outgoing internal transactions.\n\n\n    \n        \n        \n    \n\n\nBooking and value dates\nFor every transaction returned in the API response, you receive two date fields: the  bookingDate and the  valueDate.\nThese fields indicate when the funds are recorded and when they are deducted from your balance account. For example, when you pay out to a third-party bank account after bank cutoff times, the funds are reserved but are not yet deducted. In this scenario, the dates will be:\n\n bookingDate: The date when the funds are recorded as reserved or pending in the balance account.\n valueDate: The date when the funds are deducted from or made available in the balance account.\n\nFunds are always deducted at the booked stage for outgoing transfers.","type":"page","locale":"pt","boost":17,"hierarchy":{"lvl0":"Home","lvl1":"Adyen Payouts","lvl2":"Payouts and Payments","lvl3":"Track transactions"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/pt","lvl1":"https:\/\/docs.adyen.com\/pt\/payouts","lvl2":"https:\/\/docs.adyen.com\/pt\/payouts\/payout-service","lvl3":"\/pt\/payouts\/payout-service\/transfer-transactions"},"levels":4,"category":"","category_color":"","tags":["Track","transactions"]},"articleFiles":{"incoming-external-transaction.json":"<p alt=\"\">incoming-external-transaction.json<\/p>","outgoing-external-transaction.json":"<p alt=\"\">outgoing-external-transaction.json<\/p>"}}