Amount intended to be sent to the recipient. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge €1.00 or 100 to charge FCFA100, a zero-decimal currency).
Mode in which this transfer exists.
The sandbox mode can be used during the integration phase and is available as soon as the merchant account is created. No real transactions are made in this mode.
The live mode has to be used to make real transactions.
Present, and true, only when the response replays an existing payout (idempotent replay, HTTP 200 with the X-Idempotent-Replay: true header). Absent when the transfer has just been created.
Available options:
true
Example:
true
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"HUB2 Documentation","colors":{"primary":"#0D9373","light":"#07C983","dark":"#0D9373"},"logo":{"light":"https://mintcdn.com/hub2-83/aPkTvmVeXN9HXpuW/assets/logo/hub2.png?fit=max\u0026auto=format\u0026n=aPkTvmVeXN9HXpuW\u0026q=85\u0026s=18f9f70abbe4d6234bad47152927237a","dark":"https://mintcdn.com/hub2-83/aPkTvmVeXN9HXpuW/assets/logo/hub2.png?fit=max\u0026auto=format\u0026n=aPkTvmVeXN9HXpuW\u0026q=85\u0026s=18f9f70abbe4d6234bad47152927237a"},"favicon":"https://mintcdn.com/hub2-83/aPkTvmVeXN9HXpuW/assets/favicon.png?fit=max\u0026auto=format\u0026n=aPkTvmVeXN9HXpuW\u0026q=85\u0026s=d71426a9f8f85b6c6ccce6d36247bf39","api":{"openapi":"https://api.hub2.io/docs-json"},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/hub2","website":"https://www.hub2.io"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"hub2-83","hasAudioNarration":false,"actualSubdomain":"hub2-83","customDomains":["docs.hub2.io"],"gitSource":{"type":"github","owner":"technohub2","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae16defdd9644647b4200dd","collectionId":"57fb640c-62d6-4c13-a1f8-78fc452635ea","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae16defdd9644647b4200dd"},"entitlements":{},"buildId":"6ae16defdd9644647b4200dd","clientVersion":"0.0.4006","searchFilterCounts":[{"language":"default","tag":"Référence de l'API","count":86},{"language":"default","tag":"Integration","count":44},{"language":"default","tag":"Intégration","count":44},{"language":"default","tag":"Payments","count":18},{"language":"default","tag":"Webhooks","count":17},{"language":"default","tag":"Documentation","count":16},{"language":"default","tag":"Transfers","count":11},{"language":"default","tag":"Compliance","count":10},{"language":"default","tag":"Payment Links","count":10},{"language":"default","tag":"Processing Only","count":10}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"assets/style.css","content":"table{display:table!important}.table-scroll{overflow:scroll}table tbody tr:nth-child(odd){background:#fafafa}html.dark table tbody tr:nth-child(odd){background:#1a1a1a}"}],"page":{"pagePath":"api-reference/transfers/retrieve-a-transfer-collection","slug":"/api-reference/transfers/retrieve-a-transfer-collection","pageMetadata":{"openapi":"get /transfers","title":"Retrieve a Transfer collection","description":"Return a list of Transfers, eventually filtered by criteria.","href":"/api-reference/transfers/retrieve-a-transfer-collection"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Return a list of Transfers, eventually filtered by criteria.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"get /transfers","title":"Retrieve a Transfer collection","description":"Return a list of Transfers, eventually filtered by criteria.","href":"/api-reference/transfers/retrieve-a-transfer-collection"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/hub2-83/0ef60d836fa10d10/assets/mermaid.js"],"openApiReferenceData":{"operation":{"description":"Return a list of Transfers, eventually filtered by criteria.","operationId":"TransfersController_filterGet","parameters":["df4f41cd-4611-4434-aa6a-16a9fb9df96b","a6facce7-795d-424b-b810-d31318efa708","ae221e68-bc9b-4839-9485-c5ba1094f8c5","ee2f4805-924e-4341-ba10-de4bb029b296","eb40337f-ec7d-4593-9d72-3c02647ec7fd","cc867193-5588-4eda-8608-7a34e8ce877c","e72707e6-7e65-4c32-9b3e-c3f2d0468864","ce341724-2cbd-4bb2-9b80-eb49b6ca9d70","5b0b8c91-0ffd-4f5b-8ad1-d1617eb1a565"],"responses":{"200":"278087dc-f871-49d4-b471-e69c30f7ae12","400":"3f5dcea5-5a65-42d5-9b8e-b52f5207f965","401":"2a861af4-5d9e-4f32-b7fe-42b800c42361","404":"c62dc5be-b1b3-4ed0-ae25-c967c815d27d","429":"ba61abb8-a350-4e9f-a4c3-6b204f3e165b","500":"4fb76eab-3ccc-407b-9758-bfb80a554dd1"},"summary":"Retrieve a Transfer collection","tags":["Transfers"],"method":"get","type":"path","servers":[],"security":[],"path":"/transfers","baseUrlOptions":[],"title":"Retrieve a Transfer collection","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"df4f41cd-4611-4434-aa6a-16a9fb9df96b":{"name":"reference","required":false,"in":"query","description":"The reference provided by the client during the creation of this transfer. It will most likely be the internal ID of the transaction.","schema":{"example":"ref_2020_11_10_001","type":"string","isRequired":false,"description":"The reference provided by the client during the creation of this transfer. It will most likely be the internal ID of the transaction.","uniqueKey":"","typeLabel":"string"}},"a6facce7-795d-424b-b810-d31318efa708":{"name":"isDelegated","required":false,"in":"query","description":"Only transactions matching the given delegated status","schema":{"example":true,"type":"boolean","isRequired":false,"description":"Only transactions matching the given delegated status","uniqueKey":"","typeLabel":"boolean"}},"ae221e68-bc9b-4839-9485-c5ba1094f8c5":{"name":"to","required":false,"in":"query","description":"A date in UTC timezone to filters data to, inclusively.\n Follows the [Datetime ISO](https://en.wikipedia.org/wiki/ISO_8601).\n The default value is now().","schema":{"example":"2020-10-15T12:09:49.355Z","type":"string","isRequired":false,"description":"A date in UTC timezone to filters data to, inclusively.\n Follows the [Datetime ISO](https://en.wikipedia.org/wiki/ISO_8601).\n The default value is now().","uniqueKey":"","typeLabel":"string"}},"ee2f4805-924e-4341-ba10-de4bb029b296":{"name":"from","required":false,"in":"query","description":"A date in UTC timezone to filters data from, inclusively.\n Follows the [Datetime ISO](https://en.wikipedia.org/wiki/ISO_8601).\n The default value is the first day of this month.","schema":{"example":"2020-10-15T12:09:49.355Z","type":"string","isRequired":false,"description":"A date in UTC timezone to filters data from, inclusively.\n Follows the [Datetime ISO](https://en.wikipedia.org/wiki/ISO_8601).\n The default value is the first day of this month.","uniqueKey":"","typeLabel":"string"}},"eb40337f-ec7d-4593-9d72-3c02647ec7fd":{"name":"page","required":false,"in":"query","description":"The page number in the returned data. The default value is 1.\n Do use with 'perPage' query parameter to paginate properly.","schema":{"example":2,"type":"number","isRequired":false,"description":"The page number in the returned data. The default value is 1.\n Do use with 'perPage' query parameter to paginate properly.","uniqueKey":"","typeLabel":"number"}},"cc867193-5588-4eda-8608-7a34e8ce877c":{"name":"perPage","required":false,"in":"query","description":"The maximum number of results that will be return. The default value is 10.\n Do use with 'page' query parameter to paginate properly.","schema":{"example":5,"type":"number","isRequired":false,"description":"The maximum number of results that will be return. The default value is 10.\n Do use with 'page' query parameter to paginate properly.","uniqueKey":"","typeLabel":"number"}},"e72707e6-7e65-4c32-9b3e-c3f2d0468864":{"name":"ApiKey","in":"header","description":"Your api key. To create a key, please get into our dashboard. If you don't have access to it, please reach the Support team.","required":true,"schema":{"type":"string","isRequired":true,"description":"Your api key. To create a key, please get into our dashboard. If you don't have access to it, please reach the Support team.","uniqueKey":"","typeLabel":"string"}},"ce341724-2cbd-4bb2-9b80-eb49b6ca9d70":{"name":"MerchantId","in":"header","description":"Your merchant ID. This information is available in our dashboard. If you don't have access to it, please reach the Support team.","required":true,"schema":{"type":"string","isRequired":true,"description":"Your merchant ID. This information is available in our dashboard. If you don't have access to it, please reach the Support team.","uniqueKey":"","typeLabel":"string"}},"5b0b8c91-0ffd-4f5b-8ad1-d1617eb1a565":{"name":"Environment","in":"header","description":"Allow you to choose between the sandbox mode to perform some tests or the live mode for real world transactions.","required":true,"schema":{"type":"string","enum":["live","sandbox"],"isRequired":true,"description":"Allow you to choose between the sandbox mode to perform some tests or the live mode for real world transactions.","uniqueKey":"","typeLabel":"enum\u003cstring>"}}},"responses":{"278087dc-f871-49d4-b471-e69c30f7ae12":{"headers":{"Content-Range":{"description":"Indicate the response's range. Follow the format : start-end/total","example":"5-9/16","schema":{"type":"string"}}},"description":"","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the Transfer","example":"tr_z1urYtVFgEebtcj8fxp4v","isRequired":true,"uniqueKey":"items.[INDEX].id","typeLabel":"string"},"merchantId":{"type":"string","description":"Identifier of the merchant owning this Transfer","isRequired":true,"uniqueKey":"items.[INDEX].merchantId","typeLabel":"string"},"createdAt":{"type":"string","description":"Datetime in UTC timezone at which this object was created.\n Follows the [Datetime ISO](https://en.wikipedia.org/wiki/ISO_8601).","example":"2020-10-15T12:09:49.355Z","isRequired":true,"uniqueKey":"items.[INDEX].createdAt","typeLabel":"string"},"updatedAt":{"type":"string","description":"Datetime in UTC timezone at which this object was updated for the last time .\n Follows the [Datetime ISO](https://en.wikipedia.org/wiki/ISO_8601).","example":"2020-10-15T12:16:26.128Z","isRequired":true,"uniqueKey":"items.[INDEX].updatedAt","typeLabel":"string"},"reference":{"type":"string","description":"A reference provided by the client during the creation of this Transfer","example":"ref_2020_11_10_001","isRequired":true,"uniqueKey":"items.[INDEX].reference","typeLabel":"string"},"description":{"type":"string","description":"An arbitrary string attached to the Transfer. Mostly useful for displaying to user. ","isRequired":true,"uniqueKey":"items.[INDEX].description","typeLabel":"string"},"status":{"type":"string","description":"The current status of this Transfer","example":"successful","enum":["created","successful","pending","failed"],"isRequired":true,"uniqueKey":"items.[INDEX].status","typeLabel":"enum\u003cstring>"},"amount":{"type":"number","description":"Amount intended to be sent to the recipient. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge €1.00 or 100 to charge FCFA100, a zero-decimal currency).","example":100,"isRequired":true,"uniqueKey":"items.[INDEX].amount","typeLabel":"number"},"currency":{"type":"string","description":"Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html).","example":"XOF","isRequired":true,"uniqueKey":"items.[INDEX].currency","typeLabel":"string"},"mode":{"type":"string","description":"Mode in which this transfer exists.\n The sandbox mode can be used during the integration phase and is available as soon as the merchant account is created. No real transactions are made in this mode.\n The live mode has to be used to make real transactions.","example":"live","enum":["live","sandbox"],"isRequired":true,"uniqueKey":"items.[INDEX].mode","typeLabel":"enum\u003cstring>"},"destination":{"oneOf":[{"type":"object","title":"Destination","description":"Information about the recipient of this Transfer","required":["type","country","number","provider"],"properties":{"type":{"type":"string","description":"The method selected to make this Transfer","example":"mobile_money","enum":["mobile_money","bank_transfer","airtime","instant_payment"],"isRequired":true,"uniqueKey":"items.[INDEX].destination.oneOf.0.type","typeLabel":"enum\u003cstring>"},"country":{"type":"string","description":"Two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Represents the country where the provider selected by the customer is localized. ","example":"CI","isRequired":true,"uniqueKey":"items.[INDEX].destination.oneOf.0.country","typeLabel":"string"},"number":{"type":"string","description":"The identifier referencing the payment method of the customer.\n - In case of a payment by Mobile Money, it corresponds to the customer phone number corresponding to his Mobile Money account","isRequired":true,"uniqueKey":"items.[INDEX].destination.oneOf.0.number","typeLabel":"string"},"provider":{"type":"string","description":"The name of the provider selected by the customer, in lowercase. The list of supported providers can be found at [/data/providers](#operation/DataController_getProviders)","example":"orange","isRequired":true,"uniqueKey":"items.[INDEX].destination.oneOf.0.provider","typeLabel":"string"},"recipientName":{"type":"string","description":"recipient's Name","uniqueKey":"items.[INDEX].destination.oneOf.0.recipientName","typeLabel":"string"}},"isRequired":true,"uniqueKey":"items.[INDEX].destination.oneOf.0","typeLabel":"Destination · object"},{"type":"object","title":"Destination","description":"Information about the recipient of this Transfer","required":["type","country","number","accountOwner","bankCode","bankName","beneficiaryPhone"],"properties":{"type":{"type":"string","description":"The method selected to make this Transfer","example":"mobile_money","enum":["mobile_money","bank_transfer","airtime","instant_payment"],"isRequired":true,"uniqueKey":"items.[INDEX].destination.oneOf.1.type","typeLabel":"enum\u003cstring>"},"country":{"type":"string","description":"Two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Represents the country where the provider selected by the customer is localized. ","example":"CI","isRequired":true,"uniqueKey":"items.[INDEX].destination.oneOf.1.country","typeLabel":"string"},"number":{"type":"string","description":"The identifier referencing the payment method of the customer.\n - In case of a payment by Bank Transfer, it corresponds to the customer bank account number","isRequired":true,"uniqueKey":"items.[INDEX].destination.oneOf.1.number","typeLabel":"string"},"accountOwner":{"type":"string","description":"The Bank account owner name to which the money must be sent.","isRequired":true,"uniqueKey":"items.[INDEX].destination.oneOf.1.accountOwner","typeLabel":"string"},"bankCode":{"type":"string","description":"The Bank code.","isRequired":true,"uniqueKey":"items.[INDEX].destination.oneOf.1.bankCode","typeLabel":"string"},"bankName":{"type":"string","description":"The Bank name.","isRequired":true,"uniqueKey":"items.[INDEX].destination.oneOf.1.bankName","typeLabel":"string"},"beneficiaryPhone":{"type":"string","description":"The Beneficiary phone","isRequired":true,"uniqueKey":"items.[INDEX].destination.oneOf.1.beneficiaryPhone","typeLabel":"string"},"recipientName":{"type":"string","description":"recipient's Name","uniqueKey":"items.[INDEX].destination.oneOf.1.recipientName","typeLabel":"string"}},"isRequired":true,"uniqueKey":"items.[INDEX].destination.oneOf.1","typeLabel":"Destination · object"},{"type":"object","title":"Destination","description":"Information about the recipient of this Transfer","required":["type","country","number","provider"],"properties":{"type":{"type":"string","description":"The method selected to make this Transfer","example":"mobile_money","enum":["mobile_money","bank_transfer","airtime","instant_payment"],"isRequired":true,"uniqueKey":"items.[INDEX].destination.oneOf.2.type","typeLabel":"enum\u003cstring>"},"country":{"type":"string","description":"Two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Represents the country where the provider selected by the customer is localized. ","example":"CI","isRequired":true,"uniqueKey":"items.[INDEX].destination.oneOf.2.country","typeLabel":"string"},"number":{"type":"string","description":"The identifier referencing the payment method of the customer.\n - In case of a payment by Airtime, it corresponds to the customer phone number corresponding to his Airtime account","isRequired":true,"uniqueKey":"items.[INDEX].destination.oneOf.2.number","typeLabel":"string"},"provider":{"type":"string","description":"The name of the provider selected by the customer, in lowercase. The list of supported providers can be found at [/data/providers](#operation/DataController_getProviders)","example":"orange","isRequired":true,"uniqueKey":"items.[INDEX].destination.oneOf.2.provider","typeLabel":"string"},"recipientName":{"type":"string","description":"recipient's Name","uniqueKey":"items.[INDEX].destination.oneOf.2.recipientName","typeLabel":"string"}},"isRequired":true,"uniqueKey":"items.[INDEX].destination.oneOf.2","typeLabel":"Destination · object"},{"type":"object","title":"Destination","description":"Information about the recipient of this Transfer","required":["type","country","provider"],"properties":{"type":{"type":"string","description":"The method selected to make this Transfer","example":"instant_payment","enum":["mobile_money","bank_transfer","airtime","instant_payment"],"isRequired":true,"uniqueKey":"items.[INDEX].destination.oneOf.3.type","typeLabel":"enum\u003cstring>"},"country":{"type":"string","description":"Two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Represents the country where the provider selected by the customer is localized. ","example":"CI","isRequired":true,"uniqueKey":"items.[INDEX].destination.oneOf.3.country","typeLabel":"string"},"provider":{"type":"string","description":"The provider serving this destination. Always `pispi` for instant payment.","example":"pispi","isRequired":true,"uniqueKey":"items.[INDEX].destination.oneOf.3.provider","typeLabel":"string"},"recipientName":{"type":"string","description":"recipient's Name","uniqueKey":"items.[INDEX].destination.oneOf.3.recipientName","typeLabel":"string"},"payerAlias":{"type":"string","description":"The alias of the account debited — the merchant's own transfer account. On `POST /transfers` it is chosen by HUB2 from the merchant's registered aliases rather than taken from the request.","example":"7c9e6679-7425-40de-944b-e07fc1f90ae7","uniqueKey":"items.[INDEX].destination.oneOf.3.payerAlias","typeLabel":"string"},"payeeAlias":{"type":"string","description":"The alias of the beneficiary paid, as supplied on the request.","example":"+2250700000009","uniqueKey":"items.[INDEX].destination.oneOf.3.payeeAlias","typeLabel":"string"}},"isRequired":true,"uniqueKey":"items.[INDEX].destination.oneOf.3","typeLabel":"Destination · object"}],"isRequired":true,"uniqueKey":"items.[INDEX].destination","typeLabel":"Destination · object"},"fees":{"description":"Fees applied to merchant's transfer-account uppon success","title":"TransferFee","type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the applied Fee object.","example":"lAe5HnFpvOjwdT9vSIgPA","isRequired":true,"uniqueKey":"items.[INDEX].fees.items.[INDEX].id","typeLabel":"string"},"rate":{"type":"number","description":"A rate corresponding to the amount (flat or percentage) applied by the fees.","isRequired":true,"uniqueKey":"items.[INDEX].fees.items.[INDEX].rate","typeLabel":"number"},"type":{"type":"string","description":"The type of fee applied to the transfer's amount\n \n - flat: A fixed amount applied as is to the amount.\n \n - percent: A rate applied to the amount as a percentage of the latter.","enum":["flat","percent"],"isRequired":true,"uniqueKey":"items.[INDEX].fees.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"amount":{"type":"number","description":"Amount applied by this Fees. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge €1.00 or 100 to charge FCFA100, a zero-decimal currency).","example":5,"isRequired":true,"uniqueKey":"items.[INDEX].fees.items.[INDEX].amount","typeLabel":"number"},"currency":{"type":"string","description":"Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html).","example":"XOF","isRequired":true,"uniqueKey":"items.[INDEX].fees.items.[INDEX].currency","typeLabel":"string"},"taxes":{"description":"An array containing every taxes applied to a fee","type":"array","items":{"type":"string","uniqueKey":"items.[INDEX].fees.items.[INDEX].taxes.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"items.[INDEX].fees.items.[INDEX].taxes","typeLabel":"string[]"},"label":{"type":"string","description":"An optional label giving information on the reason of this fees.","uniqueKey":"items.[INDEX].fees.items.[INDEX].label","typeLabel":"string"}},"required":["id","rate","type","amount","currency","taxes"],"uniqueKey":"items.[INDEX].fees.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"items.[INDEX].fees","typeLabel":"TransferFee · object[]"},"isIrt":{"type":"boolean","description":"indicate if the transfer was international","title":"isIrt","isRequired":true,"uniqueKey":"items.[INDEX].isIrt","typeLabel":"boolean"},"providerReference":{"type":"string","description":"provider reference that identify this transfer","title":"providerReference","isRequired":true,"uniqueKey":"items.[INDEX].providerReference","typeLabel":"string"},"isDelegated":{"type":"boolean","description":"Indicates if the transfer is delegated","title":"isDelegated","isRequired":true,"uniqueKey":"items.[INDEX].isDelegated","typeLabel":"boolean"},"aggregatedMerchantId":{"type":"string","description":"Aggregated merchant id","title":"aggregatedMerchantId","isRequired":true,"uniqueKey":"items.[INDEX].aggregatedMerchantId","typeLabel":"string"},"failureCause":{"type":"object","title":"TransferFailureCause","description":"In case of failure, this object will describe the reason of the failure","required":["code","message","params"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"items.[INDEX].failureCause.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"items.[INDEX].failureCause.message","typeLabel":"string"},"params":{"type":"array","items":{"type":"string","uniqueKey":"items.[INDEX].failureCause.params.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"items.[INDEX].failureCause.params","typeLabel":"string[]"}},"uniqueKey":"items.[INDEX].failureCause","typeLabel":"TransferFailureCause · object"},"origin":{"type":"object","title":"Origin","description":"Information about the origin of this transfer","properties":{"name":{"type":"string","description":"Sender's name","uniqueKey":"items.[INDEX].origin.name","typeLabel":"string"},"country":{"type":"string","description":"Sender's country. Two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)","uniqueKey":"items.[INDEX].origin.country","typeLabel":"string"}},"uniqueKey":"items.[INDEX].origin","typeLabel":"Origin · object"},"overrideBusinessName":{"type":"string","description":"override business name for aggregator","title":"overrideBusinessName","uniqueKey":"items.[INDEX].overrideBusinessName","typeLabel":"string"},"overrideBusinessId":{"type":"string","description":"override business id for merchant","title":"overrideBusinessId","uniqueKey":"items.[INDEX].overrideBusinessId","typeLabel":"string"},"subMerchantId":{"type":"string","description":"Submerchant ID","example":"submerchant_123","uniqueKey":"items.[INDEX].subMerchantId","typeLabel":"string"},"transferInformation":{"type":"object","description":"Merchant-defined payment metadata from transfer creation.","example":{"recipient_name_hashmac":"9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08","transaction_purpose":"SALARY"},"properties":{"recipient_name_hashmac":{"type":"string","description":"HMAC-SHA256 of the full name of the person receiving the funds, computed on the partner side and hex-encoded (64 characters). Case-insensitive on input, returned in lower case.","example":"9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08","pattern":"^[0-9a-fA-F]{64}$","maxLength":64,"uniqueKey":"items.[INDEX].transferInformation.recipient_name_hashmac","typeLabel":"string"},"customer_id_hashmac":{"type":"string","description":"HMAC-SHA256, hex-encoded (64 characters), of your identifier for the end user receiving the funds: your customer id, or the end-user phone number when you have no customer id. Expected from every merchant on a payout: currently monitored, it will become mandatory on a date announced in advance. Case-insensitive on input, returned in lower case.","example":"9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08","pattern":"^[0-9a-fA-F]{64}$","maxLength":64,"uniqueKey":"items.[INDEX].transferInformation.customer_id_hashmac","typeLabel":"string"},"transaction_purpose":{"type":"string","description":"Declared purpose of the payout for compliance and monitoring. Expected from every merchant on a payout (map it from the note or comment you already attach to the payout): currently monitored, it will become mandatory on a date announced in advance.","enum":["SALARY","LOAN_DISBURSEMENT","COMMISSION","REFUND","CASHOUT","OTHER"],"example":"SALARY","uniqueKey":"items.[INDEX].transferInformation.transaction_purpose","typeLabel":"enum\u003cstring>"}},"uniqueKey":"items.[INDEX].transferInformation","typeLabel":"object"},"idempotentReplay":{"type":"boolean","description":"Present, and `true`, only when the response replays an existing payout (idempotent replay, HTTP 200 with the `X-Idempotent-Replay: true` header). Absent when the transfer has just been created.","enum":[true],"example":true,"uniqueKey":"items.[INDEX].idempotentReplay","typeLabel":"enum\u003cboolean>"}},"required":["id","merchantId","createdAt","updatedAt","reference","description","status","amount","currency","mode","destination","fees","isIrt","providerReference","isDelegated","aggregatedMerchantId"],"uniqueKey":"items.[INDEX]","typeLabel":"object"},"uniqueKey":"","typeLabel":"object[]"},"examples":{"Example":{"title":"Example","value":[{"id":"tr_z1urYtVFgEebtcj8fxp4v","merchantId":"\u003cstring>","createdAt":"2020-10-15T12:09:49.355Z","updatedAt":"2020-10-15T12:16:26.128Z","reference":"ref_2020_11_10_001","description":"\u003cstring>","status":"successful","amount":100,"currency":"XOF","mode":"live","destination":{"type":"mobile_money","country":"CI","number":"\u003cstring>","provider":"orange","recipientName":"\u003cstring>"},"fees":[{"id":"lAe5HnFpvOjwdT9vSIgPA","rate":123,"type":"flat","amount":5,"currency":"XOF","taxes":["\u003cstring>"],"label":"\u003cstring>"}],"isIrt":true,"providerReference":"\u003cstring>","isDelegated":true,"aggregatedMerchantId":"\u003cstring>","failureCause":{"code":"\u003cstring>","message":"\u003cstring>","params":["\u003cstring>"]},"origin":{"name":"\u003cstring>","country":"\u003cstring>"},"overrideBusinessName":"\u003cstring>","overrideBusinessId":"\u003cstring>","subMerchantId":"submerchant_123","transferInformation":{"recipient_name_hashmac":"9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08","transaction_purpose":"SALARY"},"idempotentReplay":true}]}},"exampleType":"generated"}},"exampleType":"generated"},"3f5dcea5-5a65-42d5-9b8e-b52f5207f965":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number","description":"HTTP error code.","example":400,"isRequired":true,"uniqueKey":"status","typeLabel":"number"},"error":{"type":"object","description":"HTTP error description.","required":["statusCode","message","error"],"properties":{"statusCode":{"type":"number","description":"HTTP error code.","example":400,"isRequired":true,"uniqueKey":"error.statusCode","typeLabel":"number"},"message":{"description":"Detailed error message or array of messages to describe what's wrong.","example":["destination.provider must be a string"],"type":"array","items":{"type":"string","uniqueKey":"error.message.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"error.message","typeLabel":"string[]"},"error":{"type":"string","description":"The error message","example":"Bad Request","isRequired":true,"uniqueKey":"error.error","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["status","error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":400,"error":{"statusCode":400,"message":["destination.provider must be a string"],"error":"Bad Request"}}}},"exampleType":"generated"}},"exampleType":"generated"},"2a861af4-5d9e-4f32-b7fe-42b800c42361":{"description":"Wrong credentials","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number","description":"HTTP error code.","example":401,"isRequired":true,"uniqueKey":"status","typeLabel":"number"},"error":{"type":"object","description":"HTTP error description.","required":["type","code","message"],"properties":{"type":{"type":"string","description":"The type of this error.","example":"authorization_error","isRequired":true,"uniqueKey":"error.type","typeLabel":"string"},"code":{"type":"string","description":"The internal error code describing what happened.","enum":["bad_payment_intent_token","wrong_credentials"],"example":"wrong_credentials","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Detailed error message which describe what happened.","example":"L'ID marchand et/ou la clé d'API sont incorrects.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["status","error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":401,"error":{"type":"authorization_error","code":"wrong_credentials","message":"L'ID marchand et/ou la clé d'API sont incorrects."}}}},"exampleType":"generated"}},"exampleType":"generated"},"c62dc5be-b1b3-4ed0-ae25-c967c815d27d":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"httpStatus":{"type":"number","description":"Http status","enum":[404],"example":404,"isRequired":true,"uniqueKey":"httpStatus","typeLabel":"enum\u003cnumber>"},"message":{"type":"string","description":"Detailed error message which describe what happened.","example":"X not found","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"error":{"type":"string","description":"Error message","example":"Not found","isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"required":["httpStatus","message","error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"httpStatus":404,"message":"X not found","error":"Not found"}}},"exampleType":"generated"}},"exampleType":"generated"},"ba61abb8-a350-4e9f-a4c3-6b204f3e165b":{"description":"ThrottlerException: Too Many Requests","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number","description":"status","enum":[429],"example":429,"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cnumber>"},"error":{"type":"string","description":"Error","example":"ThrottlerException: Too Many Requests","isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"required":["status","error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":429,"error":"ThrottlerException: Too Many Requests"}}},"exampleType":"generated"}},"exampleType":"generated"},"4fb76eab-3ccc-407b-9758-bfb80a554dd1":{"description":"Internal error","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"The type of this error.","example":"internal_error","isRequired":true,"uniqueKey":"type","typeLabel":"string"},"code":{"type":"string","description":"The error code for this error.","example":["internal_error","wrong_credentials","not_granted","live_mode_not_granted"],"isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","description":"The error message describing what happens to throw this error.","example":"An error occurred on our system. Please try again later.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["type","code","message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"internal_error","code":["internal_error","wrong_credentials","not_granted","live_mode_not_granted"],"message":"An error occurred on our system. Please try again later."}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{},"servers":{}},"originalFileLocation":"https://api.hub2.io/docs-json"},"subdomain":"hub2-83","siteName":"HUB2 Documentation","title":"Retrieve a Transfer collection - HUB2 Documentation","navMaps":{"firstHrefInVersion":{"English":{"href":"/api-reference/transfers/retrieve-a-transfer-collection","matchLevel":0},"Français":{"href":"/api-reference/transfers/retrieve-a-transfer-collection","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2025-08-08T09:14:39.019Z","originalFileLocation":"api-reference/transfers/retrieve-a-transfer-collection.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Return a list of Transfers, eventually filtered by criteria.\">\u003cmeta data-mint-head name=\"application-name\" content=\"HUB2 Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/hub2-83/2cSAgZof76cJIDy-/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/hub2-83/2cSAgZof76cJIDy-/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/hub2-83/2cSAgZof76cJIDy-/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/hub2-83/2cSAgZof76cJIDy-/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/hub2-83/2cSAgZof76cJIDy-/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/hub2-83/2cSAgZof76cJIDy-/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/hub2-83/2cSAgZof76cJIDy-/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/hub2-83/2cSAgZof76cJIDy-/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/hub2-83/2cSAgZof76cJIDy-/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Retrieve a Transfer collection - HUB2 Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Return a list of Transfers, eventually filtered by criteria.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"HUB2 Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.hub2.io/api-reference/transfers/retrieve-a-transfer-collection\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://hub2-83.mintlify.app/_mintlify/api/og/v2?division=Transfers\u0026amp;title=Retrieve+a+Transfer+collection\u0026amp;description=Return+a+list+of+Transfers%2C+eventually+filtered+by+criteria.\u0026amp;theme=92cb3d561e9d2318e8ed5cd1\u0026amp;signature=e278a42a448f012ceb27276cac9b1f85b0ab58444a9dbbc81a75706887507eb3\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Retrieve a Transfer collection - HUB2 Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Return a list of Transfers, eventually filtered by criteria.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://hub2-83.mintlify.app/_mintlify/api/og/v2?division=Transfers\u0026amp;title=Retrieve+a+Transfer+collection\u0026amp;description=Return+a+list+of+Transfers%2C+eventually+filtered+by+criteria.\u0026amp;theme=92cb3d561e9d2318e8ed5cd1\u0026amp;signature=e278a42a448f012ceb27276cac9b1f85b0ab58444a9dbbc81a75706887507eb3\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/hub2-83/2cSAgZof76cJIDy-/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"HUB2 Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0D9373\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.hub2.io/api-reference/transfers/retrieve-a-transfer-collection\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/transfers/retrieve-a-transfer-collection.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.hub2.io/#organization\",\"name\":\"HUB2 Documentation\",\"url\":\"https://docs.hub2.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/hub2-83/aPkTvmVeXN9HXpuW/assets/logo/hub2.png?fit=max\u0026auto=format\u0026n=aPkTvmVeXN9HXpuW\u0026q=85\u0026s=18f9f70abbe4d6234bad47152927237a\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.hub2.io#website\",\"name\":\"HUB2 Documentation\",\"url\":\"https://docs.hub2.io\",\"publisher\":{\"@id\":\"https://docs.hub2.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.hub2.io/api-reference/transfers/retrieve-a-transfer-collection#webpage\",\"url\":\"https://docs.hub2.io/api-reference/transfers/retrieve-a-transfer-collection\",\"name\":\"Retrieve a Transfer collection\",\"description\":\"Return a list of Transfers, eventually filtered by criteria.\",\"dateModified\":\"2025-08-08T09:14:39.019Z\",\"isPartOf\":{\"@id\":\"https://docs.hub2.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.hub2.io/api-reference/transfers/retrieve-a-transfer-collection#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.hub2.io/api-reference/transfers/retrieve-a-transfer-collection#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"HUB2 Documentation\",\"item\":\"https://docs.hub2.io\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Retrieve a Transfer collection\",\"item\":\"https://docs.hub2.io/api-reference/transfers/retrieve-a-transfer-collection\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.hub2.io/api-reference/transfers/retrieve-a-transfer-collection#apireference\",\"headline\":\"Retrieve a Transfer collection\",\"name\":\"Retrieve a Transfer collection\",\"description\":\"Return a list of Transfers, eventually filtered by criteria.\",\"url\":\"https://docs.hub2.io/api-reference/transfers/retrieve-a-transfer-collection\",\"mainEntityOfPage\":{\"@id\":\"https://docs.hub2.io/api-reference/transfers/retrieve-a-transfer-collection#webpage\"},\"dateModified\":\"2025-08-08T09:14:39.019Z\",\"publisher\":{\"@id\":\"https://docs.hub2.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.hub2.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"HUB2 Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"HUB2 Documentation","nav":{"global":null,"versions":[{"version":"English","tabs":[{"tab":"HUB2"},{"tab":"Integration","pages":[{"title":"Integration","href":"/integration/en/getting_started/introduction"}]},{"tab":"Documentation","pages":[{"title":"Documentation","href":"/documentation/en/glossary"}]},{"tab":"API Reference","groups":[{"group":"Data","pages":[{"openapi":"get /data/countries","title":"Get countries","href":"/api-reference/data/get-countries"},{"openapi":"get /data/providers","title":"Get providers","href":"/api-reference/data/get-providers"},{"openapi":"get /data/bank-codes","title":"Get bank codes","href":"/api-reference/data/get-bank-codes"}]},{"group":"Balance","pages":[{"openapi":"get /balance","title":"Check Merchant Balance","href":"/api-reference/balance/check-merchant-balance"}]},{"group":"Webhooks","pages":[{"openapi":"get /webhooks","title":"Get all webhooks","href":"/api-reference/webhooks/get-all-webhooks"},{"openapi":"post /webhooks","title":"Create a webhook","href":"/api-reference/webhooks/create-a-webhook"},{"openapi":"get /webhooks/{id}","title":"Get a webhook","href":"/api-reference/webhooks/get-a-webhook"},{"openapi":"delete /webhooks/{id}","title":"Remove a webhook","href":"/api-reference/webhooks/remove-a-webhook"},{"openapi":"patch /webhooks/{id}","title":"Update a webhook","href":"/api-reference/webhooks/update-a-webhook"}]},{"group":"Sms","pages":[{"openapi":"get /sms/count","title":"Retrieve number of sms sent","href":"/api-reference/sms/retrieve-number-of-sms-sent"},{"openapi":"get /sms/list","title":"Get a list of sms sent","href":"/api-reference/sms/get-a-list-of-sms-sent"},{"openapi":"post /sms","title":"Send Sms","href":"/api-reference/sms/send-sms"}]},{"group":"Payments","pages":[{"openapi":"get /payment-intents","title":"Retrieve a PaymentIntent collection","href":"/api-reference/payments/retrieve-a-paymentintent-collection"},{"openapi":"post /payment-intents","title":"Create a PaymentIntent object","href":"/api-reference/payments/create-a-paymentintent-object"},{"openapi":"get /payment-intents/{id}","title":"Retrieve a PaymentIntent object","href":"/api-reference/payments/retrieve-a-paymentintent-object"},{"openapi":"post /payment-intents/{id}/payments","title":"Attempt a payment on a PaymentIntent object","href":"/api-reference/payments/attempt-a-payment-on-a-paymentintent-object"},{"openapi":"post /payment-intents/{id}/payments/sync","title":"Synchronously attempt a payment on a payment intent","href":"/api-reference/payments/synchronously-attempt-a-payment-on-a-payment-intent"},{"openapi":"post /payment-intents/{id}/authentication","title":"Authenticate the current payment","href":"/api-reference/payments/authenticate-the-current-payment"},{"openapi":"get /payment-intents/{id}/payment-fees","title":"Retrieve fees","href":"/api-reference/payments/retrieve-fees"},{"openapi":"get /payment-intents/url/{token}","title":"Retrieve configured URLs","href":"/api-reference/payments/retrieve-configured-urls"},{"openapi":"get /payment-intents/{id}/status","title":"Retrieve a PaymentIntent status","href":"/api-reference/payments/retrieve-a-paymentintent-status"},{"openapi":"get /payments","title":"Retrieve a Payments collection","href":"/api-reference/payments/retrieve-a-payments-collection"},{"openapi":"get /payments/{id}/status","title":"Retrieve the status payment object","href":"/api-reference/payments/retrieve-the-status-payment-object"}]},{"group":"Provisioning","pages":[{"openapi":"get /provisionings","title":"Retrieve a Provisionings collection","href":"/api-reference/provisioning/retrieve-a-provisionings-collection"},{"openapi":"post /provisionings","title":"Create a Provisioning","href":"/api-reference/provisioning/create-a-provisioning"},{"openapi":"get /provisionings/{id}","title":"Retrieve a Provisioning from given id","href":"/api-reference/provisioning/retrieve-a-provisioning-from-given-id"}]},{"group":"Receipt","pages":[{"openapi":"get /receipts/{id}","title":"Retrieve a Receipt","href":"/api-reference/receipt/retrieve-a-receipt"},{"openapi":"get /receipts/html/{id}","title":"Retrieve a Receipt as an HTML representation","href":"/api-reference/receipt/retrieve-a-receipt-as-an-html-representation"}]},{"group":"Payment on Terminal","pages":[{"openapi":"post /terminal/payments","title":"Execute payment","href":"/api-reference/payment-on-terminal/execute-payment"},{"openapi":"get /terminal/payments/{id}","title":"Retrieve a payment","href":"/api-reference/payment-on-terminal/retrieve-a-payment"}]},{"group":"IRT","pages":[{"openapi":"get /irt/transfer","title":"Retrieve a IRT transfers collection","href":"/api-reference/irt/retrieve-a-irt-transfers-collection"},{"openapi":"post /irt/transfer","title":"Create IRT transfer","href":"/api-reference/irt/create-irt-transfer"},{"openapi":"post /irt/transfer/verified-recipient","title":"Create an IRT transfer to a verified recipient","description":"Make an IRT transfer to a verified recipient","href":"/api-reference/irt/create-irt-transfer-verified-recipient"}]},{"group":"Transfers","pages":[{"openapi":"get /transfers","title":"Retrieve a Transfer collection","href":"/api-reference/transfers/retrieve-a-transfer-collection"},{"openapi":"post /transfers","title":"Create Transfer","description":"This endpoint allows you to make a transfer (PAY-OUT)","href":"/api-reference/transfers/create-transfer"},{"openapi":"get /transfers/{id}","title":"Retrieve a Transfer","href":"/api-reference/transfers/retrieve-a-transfer"},{"openapi":"get /transfers/{id}/balance","title":"Retrieve a transfer's balance","href":"/api-reference/transfers/retrieve-a-transfers-balance"},{"openapi":"get /transfers/{id}/status","title":"Retrieve a transfer's status","href":"/api-reference/transfers/retrieve-a-transfers-status"},{"openapi":"post /transfers/status","title":"Retrieve the status of several transfers","href":"/api-reference/transfers/retrieve-transfers-status"}]},{"group":"Refunds","pages":[{"title":"Retrieve refunds collection","api":"GET https://api.hub2.io/refunds","href":"/api-reference/refunds/retrieve-refunds-collection"},{"openapi":"post /refunds/refund","title":"Create Refund","href":"/api-reference/refunds/create-refund"},{"title":"Retrieve a refund","api":"GET https://api.hub2.io/refunds/{id}","href":"/api-reference/refunds/retrieve-a-refund"}]},{"group":"Payment Refunds","pages":[{"openapi":"post /payments-refund/{id}/refund","title":"Create Refund for a Payment","href":"/api-reference/payments-refunds/create-refund-for-a-payment"},{"openapi":"get /payments-refund/{refundId}/status","title":"Get the status of a Payment Refund","href":"/api-reference/payments-refunds/get-the-status-of-a-payment-refund"}]},{"group":"Deposits","pages":[{"openapi":"get /deposits","title":"List deposits","href":"/api-reference/deposits/list-deposits"},{"openapi":"post /deposits","title":"Create a deposit","href":"/api-reference/deposits/create-a-deposit"},{"openapi":"get /deposits/{id}","title":"Get a deposit","href":"/api-reference/deposits/get-a-deposit"},{"openapi":"get /deposits/proof-upload-uri","title":"Get a proof upload URL","href":"/api-reference/deposits/get-a-proof-upload-url"},{"openapi":"post /deposits/{id}/proof","title":"Submit a proof","href":"/api-reference/deposits/submit-a-proof"},{"openapi":"get /deposits/{id}/proof","title":"Get deposit proof image","href":"/api-reference/deposits/get-deposit-proof-image"}]},{"group":"Compliance","pages":[{"openapi":"get /compliance/kyb/{name}","title":"Retrieve a kyb by name","href":"/api-reference/compliance/retrieve-a-kyb-by-name"},{"openapi":"put /compliance/kyb/{name}","title":"Update a kyb","href":"/api-reference/compliance/update-a-kyb"},{"openapi":"delete /compliance/kyb/{name}","title":"Delete a kyb","href":"/api-reference/compliance/delete-a-kyb"},{"openapi":"get /compliance/kyb","title":"Fetch a kyb list","href":"/api-reference/compliance/fetch-a-kyb-list"},{"openapi":"post /compliance/kyb","title":"Create a kyb","href":"/api-reference/compliance/create-a-kyb"},{"openapi":"get /compliance/transaction","title":"Fetch a kyb transactions list","href":"/api-reference/compliance/fetch-a-kyb-transactions-list"},{"openapi":"post /compliance/transaction","title":"Create a kyb transaction","href":"/api-reference/compliance/create-a-kyb-transaction"},{"openapi":"get /compliance/transaction/{reference}","title":"Retrieve a kyb transaction by reference","href":"/api-reference/compliance/retrieve-a-kyb-transaction-by-reference"},{"openapi":"delete /compliance/transaction/{reference}","title":"Delete a kyb transaction","href":"/api-reference/compliance/delete-a-kyb-transaction"},{"openapi":"get /compliance/kyc","title":"Get kyc information","href":"/api-reference/compliance/get-kyc-information"}]},{"group":"Recipients","pages":[{"openapi":"post /recipient","title":"Create a new recipient","href":"/api-reference/recipients/create-recipient"},{"openapi":"get /recipient/{id}","title":"Get a recipient by id","href":"/api-reference/recipients/find-recipient"},{"openapi":"get /recipient","title":"Retrieve a list of recipients according to filters","href":"/api-reference/recipients/list-recipients"},{"openapi":"delete /recipient/{id}","title":"Delete a recipient by id","href":"/api-reference/recipients/delete-recipient"}]},{"group":"Processing Only","pages":[{"openapi":"post /delegated/payments","title":"Create a delegated payment","href":"/api-reference/processing-only/make-a-delegated-payment"},{"openapi":"post /delegated/payments/sync","title":"Create a delegated synchronous payment","href":"/api-reference/processing-only/make-a-synchronous-delegated-payment"},{"openapi":"post /delegated/transfers","title":"Create a delegated Transfer","href":"/api-reference/processing-only/make-a-delegated-transfer"},{"openapi":"post /delegated/transfers/irt","title":"Create a delegated IRT transfer","href":"/api-reference/processing-only/make-a-delegated-transfer-irt"}]},{"group":"Payment Links","pages":[{"title":"Create a payment link","api":"POST https://api.hub2.io/payment-links","href":"/api-reference/payment_links/create_payment_links"},{"openapi":"get /payment-links","title":"List Payment Links","href":"/api-reference/payment_links/list_payment_links"},{"openapi":"get /payment-links/{id}","title":"Get Payment Link with Attempts","href":"/api-reference/payment_links/list_payment_links_with_attempts"},{"openapi":"patch /payment-links/{id}/close","title":"Close Payment Link","href":"/api-reference/payment_links/close_payment_links"}]},{"group":"Submerchants","pages":[{"openapi":"post /submerchants","title":"Create a submerchant","href":"/api-reference/submerchants/create-a-submerchant"},{"openapi":"get /submerchants","title":"List submerchants","href":"/api-reference/submerchants/list_submerchants"},{"openapi":"patch /submerchants/{submerchantId}","title":"Update a submerchant","href":"/api-reference/submerchants/update-a-submerchant"}]},{"group":"Subscriptions","pages":[{"openapi":"post /subscription-links","title":"Create Subscription Link","href":"/api-reference/subscriptions/create-a-subscription-link"},{"openapi":"post /subscription-intents","title":"Enroll a customer in card-on-file recurring debits","href":"/api-reference/subscriptions/enroll-a-customer"},{"openapi":"get /subscription-intents/{id}/status","title":"Retrieve a card-on-file enrollment status","href":"/api-reference/subscriptions/retrieve-an-enrollment-status"},{"openapi":"get /subscriptions","title":"Retrieve a Subscription collection","href":"/api-reference/subscriptions/retrieve-a-subscription-collection"},{"openapi":"post /subscriptions/{id}/charge","title":"Charge a merchant-initiated subscription on demand","href":"/api-reference/subscriptions/charge-a-subscription"},{"openapi":"post /subscriptions/{id}/suspend","title":"Suspend a subscription","href":"/api-reference/subscriptions/suspend-a-subscription"},{"openapi":"post /subscriptions/{id}/cancel","title":"Cancel a subscription","href":"/api-reference/subscriptions/cancel-a-subscription"},{"openapi":"get /subscriptions/{id}/transactions","title":"Retrieve a subscription's charge history","href":"/api-reference/subscriptions/retrieve-a-subscription-charge-history"}]},{"group":"Instant Payment","pages":[{"openapi":"get /instant-payment/accounts/{accountType}/aliases","title":"List the instant payment aliases of an account","href":"/api-reference/instant-payment/list-aliases"},{"openapi":"post /instant-payment/accounts/{accountType}/aliases","title":"Create an instant payment alias","href":"/api-reference/instant-payment/create-an-alias"},{"openapi":"delete /instant-payment/accounts/{accountType}/aliases/{aliasKey}","title":"Delete an instant payment alias","href":"/api-reference/instant-payment/delete-an-alias"}]}]}]},{"version":"Français","tabs":[{"tab":"HUB2"},{"tab":"Intégration","pages":[{"title":"Intégration","href":"/integration/fr/getting_started/introduction"}]},{"tab":"Documentation","pages":[{"title":"Documentation","href":"/documentation/fr/glossary"}]},{"tab":"Référence de l'API","groups":[{"group":"Data","pages":[{"openapi":"get /data/countries","title":"Get countries","href":"/api-reference/data/get-countries"},{"openapi":"get /data/providers","title":"Get providers","href":"/api-reference/data/get-providers"},{"openapi":"get /data/bank-codes","title":"Get bank codes","href":"/api-reference/data/get-bank-codes"}]},{"group":"Balance","pages":[{"openapi":"get /balance","title":"Check Merchant Balance","href":"/api-reference/balance/check-merchant-balance"}]},{"group":"Webhooks","pages":[{"openapi":"get /webhooks","title":"Get all webhooks","href":"/api-reference/webhooks/get-all-webhooks"},{"openapi":"post /webhooks","title":"Create a webhook","href":"/api-reference/webhooks/create-a-webhook"},{"openapi":"get /webhooks/{id}","title":"Get a webhook","href":"/api-reference/webhooks/get-a-webhook"},{"openapi":"delete /webhooks/{id}","title":"Remove a webhook","href":"/api-reference/webhooks/remove-a-webhook"},{"openapi":"patch /webhooks/{id}","title":"Update a webhook","href":"/api-reference/webhooks/update-a-webhook"}]},{"group":"Sms","pages":[{"openapi":"get /sms/count","title":"Retrieve number of sms sent","href":"/api-reference/sms/retrieve-number-of-sms-sent"},{"openapi":"get /sms/list","title":"Get a list of sms sent","href":"/api-reference/sms/get-a-list-of-sms-sent"},{"openapi":"post /sms","title":"Send Sms","href":"/api-reference/sms/send-sms"}]},{"group":"Payments","pages":[{"openapi":"get /payment-intents","title":"Retrieve a PaymentIntent collection","href":"/api-reference/payments/retrieve-a-paymentintent-collection"},{"openapi":"post /payment-intents","title":"Create a PaymentIntent object","href":"/api-reference/payments/create-a-paymentintent-object"},{"openapi":"get /payment-intents/{id}","title":"Retrieve a PaymentIntent object","href":"/api-reference/payments/retrieve-a-paymentintent-object"},{"openapi":"post /payment-intents/{id}/payments","title":"Attempt a payment on a PaymentIntent object","href":"/api-reference/payments/attempt-a-payment-on-a-paymentintent-object"},{"openapi":"post /payment-intents/{id}/payments/sync","title":"Synchronously attempt a payment on a payment intent","href":"/api-reference/payments/synchronously-attempt-a-payment-on-a-payment-intent"},{"openapi":"post /payment-intents/{id}/authentication","title":"Authenticate the current payment","href":"/api-reference/payments/authenticate-the-current-payment"},{"openapi":"get /payment-intents/{id}/payment-fees","title":"Retrieve fees","href":"/api-reference/payments/retrieve-fees"},{"openapi":"get /payment-intents/url/{token}","title":"Retrieve configured URLs","href":"/api-reference/payments/retrieve-configured-urls"},{"openapi":"get /payment-intents/{id}/status","title":"Retrieve a PaymentIntent status","href":"/api-reference/payments/retrieve-a-paymentintent-status"},{"openapi":"get /payments","title":"Retrieve a Payments collection","href":"/api-reference/payments/retrieve-a-payments-collection"},{"openapi":"get /payments/{id}/status","title":"Retrieve the status payment object","href":"/api-reference/payments/retrieve-the-status-payment-object"}]},{"group":"Provisioning","pages":[{"openapi":"get /provisionings","title":"Retrieve a Provisionings collection","href":"/api-reference/provisioning/retrieve-a-provisionings-collection"},{"openapi":"post /provisionings","title":"Create a Provisioning","href":"/api-reference/provisioning/create-a-provisioning"},{"openapi":"get /provisionings/{id}","title":"Retrieve a Provisioning from given id","href":"/api-reference/provisioning/retrieve-a-provisioning-from-given-id"}]},{"group":"Receipt","pages":[{"openapi":"get /receipts/{id}","title":"Retrieve a Receipt","href":"/api-reference/receipt/retrieve-a-receipt"},{"openapi":"get /receipts/html/{id}","title":"Retrieve a Receipt as an HTML representation","href":"/api-reference/receipt/retrieve-a-receipt-as-an-html-representation"}]},{"group":"Payment on Terminal","pages":[{"openapi":"post /terminal/payments","title":"Execute payment","href":"/api-reference/payment-on-terminal/execute-payment"},{"openapi":"get /terminal/payments/{id}","title":"Retrieve a payment","href":"/api-reference/payment-on-terminal/retrieve-a-payment"}]},{"group":"IRT","pages":[{"openapi":"get /irt/transfer","title":"Retrieve a IRT transfers collection","href":"/api-reference/irt/retrieve-a-irt-transfers-collection"},{"openapi":"post /irt/transfer","title":"Create IRT transfer","href":"/api-reference/irt/create-irt-transfer"},{"openapi":"post /irt/transfer/verified-recipient","title":"Create an IRT transfer to a verified recipient","description":"Make an IRT transfer to a verified recipient","href":"/api-reference/irt/create-irt-transfer-verified-recipient"}]},{"group":"Transfers","pages":[{"openapi":"get /transfers","title":"Retrieve a Transfer collection","href":"/api-reference/transfers/retrieve-a-transfer-collection"},{"openapi":"post /transfers","title":"Create Transfer","description":"This endpoint allows you to make a transfer (PAY-OUT)","href":"/api-reference/transfers/create-transfer"},{"openapi":"get /transfers/{id}","title":"Retrieve a Transfer","href":"/api-reference/transfers/retrieve-a-transfer"},{"openapi":"get /transfers/{id}/balance","title":"Retrieve a transfer's balance","href":"/api-reference/transfers/retrieve-a-transfers-balance"},{"openapi":"get /transfers/{id}/status","title":"Retrieve a transfer's status","href":"/api-reference/transfers/retrieve-a-transfers-status"},{"openapi":"post /transfers/status","title":"Retrieve the status of several transfers","href":"/api-reference/transfers/retrieve-transfers-status"}]},{"group":"Refunds","pages":[{"title":"Retrieve refunds collection","api":"GET https://api.hub2.io/refunds","href":"/api-reference/refunds/retrieve-refunds-collection"},{"openapi":"post /refunds/refund","title":"Create Refund","href":"/api-reference/refunds/create-refund"},{"title":"Retrieve a refund","api":"GET https://api.hub2.io/refunds/{id}","href":"/api-reference/refunds/retrieve-a-refund"}]},{"group":"Payment Refunds","pages":[{"openapi":"post /payments-refund/{id}/refund","title":"Create Refund for a Payment","href":"/api-reference/payments-refunds/create-refund-for-a-payment"},{"openapi":"get /payments-refund/{refundId}/status","title":"Get the status of a Payment Refund","href":"/api-reference/payments-refunds/get-the-status-of-a-payment-refund"}]},{"group":"Deposits","pages":[{"openapi":"get /deposits","title":"List deposits","href":"/api-reference/deposits/list-deposits"},{"openapi":"post /deposits","title":"Create a deposit","href":"/api-reference/deposits/create-a-deposit"},{"openapi":"get /deposits/{id}","title":"Get a deposit","href":"/api-reference/deposits/get-a-deposit"},{"openapi":"get /deposits/proof-upload-uri","title":"Get a proof upload URL","href":"/api-reference/deposits/get-a-proof-upload-url"},{"openapi":"post /deposits/{id}/proof","title":"Submit a proof","href":"/api-reference/deposits/submit-a-proof"},{"openapi":"get /deposits/{id}/proof","title":"Get deposit proof image","href":"/api-reference/deposits/get-deposit-proof-image"}]},{"group":"Compliance","pages":[{"openapi":"get /compliance/kyb/{name}","title":"Retrieve a kyb by name","href":"/api-reference/compliance/retrieve-a-kyb-by-name"},{"openapi":"put /compliance/kyb/{name}","title":"Update a kyb","href":"/api-reference/compliance/update-a-kyb"},{"openapi":"delete /compliance/kyb/{name}","title":"Delete a kyb","href":"/api-reference/compliance/delete-a-kyb"},{"openapi":"get /compliance/kyb","title":"Fetch a kyb list","href":"/api-reference/compliance/fetch-a-kyb-list"},{"openapi":"post /compliance/kyb","title":"Create a kyb","href":"/api-reference/compliance/create-a-kyb"},{"openapi":"get /compliance/transaction","title":"Fetch a kyb transactions list","href":"/api-reference/compliance/fetch-a-kyb-transactions-list"},{"openapi":"post /compliance/transaction","title":"Create a kyb transaction","href":"/api-reference/compliance/create-a-kyb-transaction"},{"openapi":"get /compliance/transaction/{reference}","title":"Retrieve a kyb transaction by reference","href":"/api-reference/compliance/retrieve-a-kyb-transaction-by-reference"},{"openapi":"delete /compliance/transaction/{reference}","title":"Delete a kyb transaction","href":"/api-reference/compliance/delete-a-kyb-transaction"},{"openapi":"get /compliance/kyc","title":"Get kyc information","href":"/api-reference/compliance/get-kyc-information"}]},{"group":"Recipients","pages":[{"openapi":"post /recipient","title":"Create a new recipient","href":"/api-reference/recipients/create-recipient"},{"openapi":"get /recipient/{id}","title":"Get a recipient by id","href":"/api-reference/recipients/find-recipient"},{"openapi":"get /recipient","title":"Retrieve a list of recipients according to filters","href":"/api-reference/recipients/list-recipients"},{"openapi":"delete /recipient/{id}","title":"Delete a recipient by id","href":"/api-reference/recipients/delete-recipient"}]},{"group":"Processing Only","pages":[{"openapi":"post /delegated/payments","title":"Create a delegated payment","href":"/api-reference/processing-only/make-a-delegated-payment"},{"openapi":"post /delegated/payments/sync","title":"Create a delegated synchronous payment","href":"/api-reference/processing-only/make-a-synchronous-delegated-payment"},{"openapi":"post /delegated/transfers","title":"Create a delegated Transfer","href":"/api-reference/processing-only/make-a-delegated-transfer"},{"openapi":"post /delegated/transfers/irt","title":"Create a delegated IRT transfer","href":"/api-reference/processing-only/make-a-delegated-transfer-irt"}]},{"group":"Payment Links","pages":[{"title":"Create a payment link","api":"POST https://api.hub2.io/payment-links","href":"/api-reference/payment_links/create_payment_links"},{"openapi":"get /payment-links","title":"List Payment Links","href":"/api-reference/payment_links/list_payment_links"},{"openapi":"get /payment-links/{id}","title":"Get Payment Link with Attempts","href":"/api-reference/payment_links/list_payment_links_with_attempts"},{"openapi":"patch /payment-links/{id}/close","title":"Close Payment Link","href":"/api-reference/payment_links/close_payment_links"}]},{"group":"Submerchants","pages":[{"openapi":"post /submerchants","title":"Create a submerchant","href":"/api-reference/submerchants/create-a-submerchant"},{"openapi":"get /submerchants","title":"List submerchants","href":"/api-reference/submerchants/list_submerchants"},{"openapi":"patch /submerchants/{submerchantId}","title":"Update a submerchant","href":"/api-reference/submerchants/update-a-submerchant"}]},{"group":"Subscriptions","pages":[{"openapi":"post /subscription-links","title":"Create Subscription Link","href":"/api-reference/subscriptions/create-a-subscription-link"},{"openapi":"post /subscription-intents","title":"Enroll a customer in card-on-file recurring debits","href":"/api-reference/subscriptions/enroll-a-customer"},{"openapi":"get /subscription-intents/{id}/status","title":"Retrieve a card-on-file enrollment status","href":"/api-reference/subscriptions/retrieve-an-enrollment-status"},{"openapi":"get /subscriptions","title":"Retrieve a Subscription collection","href":"/api-reference/subscriptions/retrieve-a-subscription-collection"},{"openapi":"post /subscriptions/{id}/charge","title":"Charge a merchant-initiated subscription on demand","href":"/api-reference/subscriptions/charge-a-subscription"},{"openapi":"post /subscriptions/{id}/suspend","title":"Suspend a subscription","href":"/api-reference/subscriptions/suspend-a-subscription"},{"openapi":"post /subscriptions/{id}/cancel","title":"Cancel a subscription","href":"/api-reference/subscriptions/cancel-a-subscription"},{"openapi":"get /subscriptions/{id}/transactions","title":"Retrieve a subscription's charge history","href":"/api-reference/subscriptions/retrieve-a-subscription-charge-history"}]},{"group":"Instant Payment","pages":[{"openapi":"get /instant-payment/accounts/{accountType}/aliases","title":"List the instant payment aliases of an account","href":"/api-reference/instant-payment/list-aliases"},{"openapi":"post /instant-payment/accounts/{accountType}/aliases","title":"Create an instant payment alias","href":"/api-reference/instant-payment/create-an-alias"},{"openapi":"delete /instant-payment/accounts/{accountType}/aliases/{aliasKey}","title":"Delete an instant payment alias","href":"/api-reference/instant-payment/delete-an-alias"}]}]}]}]},"title":"Retrieve a Transfer collection - HUB2 Documentation","buildId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","deploymentId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DmVyH30O.js","utils-BHQqGGOd.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-CD-E4BIt.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bp5Lq9Ds.js","snippetPresets-C4xAVCFP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CgXVLxUC.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BF8I5oUf.js","shallow-Byd0lWnC.js","getApiPlaygroundDisplay-BGOZG1OK.js","CodeSnippet-CpvQL0CY.js","CodeSnippets-B8wkBKXa.js","Page-CBCH2P7b.js","getPastedJson-Ry3scI3Y.js","icon-D7a9HcdD.js","MethodPill-CJ8pmHhz.js","DuplicateIcon-rh1HJF0t.js","createIcon-DvGznqYs.js","DynamicMarkdown-Cc6AuSHS.js","SectionHeading-B4A0S-ep.js","axios-vUo_bRtp.js","Markdown-Cc16CX65.js","clsx-Cs6nMGht.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-zbf22OZA.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-C_fs-y5n.js"]}