{ "opencollection": "1.0.0", "info": { "name": "Wise Platform 3ds transfer API", "version": "1.0" }, "items": [ { "info": { "name": "transfer", "type": "folder" }, "items": [ { "info": { "name": "List transfers", "type": "http" }, "http": { "method": "GET", "url": "https://api.wise.com/v1/transfers", "headers": [ { "name": "X-External-Correlation-Id", "value": "f47ac10b-58cc-4372-a567-0e02b2c3d479" } ], "params": [ { "name": "profile", "value": "", "type": "query", "description": "User profile ID. If parameter is omitted, defaults to user's personal profile" }, { "name": "status", "value": "", "type": "query", "description": "Comma separated list of one or more status codes to filter transfers. See [Tracking Transfers](/guides/product/send-money/tracking-transfers) for complete list of statuses" }, { "name": "sourceCurrency", "value": "", "type": "query", "description": "Source currency code" }, { "name": "targetCurrency", "value": "", "type": "query", "description": "Target currency code" }, { "name": "createdDateStart", "value": "", "type": "query", "description": "Starting date to filter transfers, inclusive of the provided date" }, { "name": "createdDateEnd", "value": "", "type": "query", "description": "Ending date to filter transfers, inclusive of the provided date" }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of records to be returned in response" }, { "name": "offset", "value": "", "type": "query", "description": "Starting record number" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get the list of transfers for a given user's profile (defaults to user's personal profile).\n\nYou can add query parameters to specify user's profile (personal or business), time period and/or payment status. For example, you can query all failed payments created since last week, or all completed payments created since yesterday.\n" }, { "info": { "name": "Create a transfer", "type": "http" }, "http": { "method": "POST", "url": "https://api.wise.com/v1/transfers", "headers": [ { "name": "X-External-Correlation-Id", "value": "f47ac10b-58cc-4372-a567-0e02b2c3d479" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a transfer to a recipient account based on a quote.\n\nSome fields are conditionally required depending on the currency route and transfer amount. Always call the [transfer requirements](/api-reference/transfer/transferrequirementsvalidate) endpoint to determine which fields are needed, and submit values accordingly. These requirements may change over time.\n\n#### Avoiding duplicate transfers\n\nThe `customerTransactionId` field is used to avoid duplicate transfer requests. If your initial cal" }, { "info": { "name": "Get a transfer by ID", "type": "http" }, "http": { "method": "GET", "url": "https://api.wise.com/v1/transfers/:transferId", "headers": [ { "name": "X-External-Correlation-Id", "value": "f47ac10b-58cc-4372-a567-0e02b2c3d479" } ], "params": [ { "name": "transferId", "value": "", "type": "path", "description": "The transfer ID" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get transfer info by ID. To receive dynamic updates as the state of the transfer changes, see the [webhooks documentation](/guides/developer/webhooks).\n" }, { "info": { "name": "Cancel a transfer", "type": "http" }, "http": { "method": "PUT", "url": "https://api.wise.com/v1/transfers/:transferId/cancel", "headers": [ { "name": "X-External-Correlation-Id", "value": "f47ac10b-58cc-4372-a567-0e02b2c3d479" } ], "params": [ { "name": "transferId", "value": "", "type": "path", "description": "The transfer ID" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Transfers may be cancelled up until the transfer has been processed and funds converted. Cancellation is final — it cannot be undone.\n\n{% admonition type=\"info\" name=\"When can a transfer be cancelled?\" %}\nA transfer can only be cancelled programmatically via the API if it meets **all** of the following criteria:\n\n- The transfer is not in `funds_converted` or later state.\n- There are no processing problems with the transfer.\n\nIf the transfer does not meet these criteria, the API will return a **4" }, { "info": { "name": "Validate transfer requirements", "type": "http" }, "http": { "method": "POST", "url": "https://api.wise.com/v1/transfer-requirements", "headers": [ { "name": "X-External-Correlation-Id", "value": "f47ac10b-58cc-4372-a567-0e02b2c3d479" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Exposes transfer-specific requirements based on the sender, quote, and target recipient account. Requirements vary by currency route, transfer amount, and regulatory region.\n\nFor example, the maximum allowed length of reference text varies — the US payment system (ACH) supports 10 characters only, but transfers within Mexico allow up to 100 characters. Similarly, depending on the chosen currencies and the amount to be transferred, Wise may require additional details such as source of funds or tr" }, { "info": { "name": "Create a third party transfer", "type": "http" }, "http": { "method": "POST", "url": "https://api.wise.com/v2/profiles/:profileId/third-party-transfers", "headers": [ { "name": "X-External-Correlation-Id", "value": "f47ac10b-58cc-4372-a567-0e02b2c3d479" } ], "params": [ { "name": "profileId", "value": "", "type": "path", "description": "The profile ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a transfer on behalf of a third party.\n\nWhen creating a third party transfer:\n- The `originator` datablock is **required**. This details the ultimate sender of funds in the transfer.\n- Depending on the legal entity type of the originator (`PRIVATE` or `BUSINESS`), the required fields vary.\n- `originalTransferId` field must be used. This is your own ID for the transfer.\n\nYou need to save the transfer ID for tracking its status later via webhooks.\n\n#### Avoiding duplicate transfers\n\nThe `or" }, { "info": { "name": "Get a third party transfer by ID (V1)", "type": "http" }, "http": { "method": "GET", "url": "https://api.wise.com/v1/profiles/:profileId/third-party-transfers/:transferId", "headers": [ { "name": "X-External-Correlation-Id", "value": "f47ac10b-58cc-4372-a567-0e02b2c3d479" } ], "params": [ { "name": "profileId", "value": "", "type": "path", "description": "The profile ID" }, { "name": "transferId", "value": "", "type": "path", "description": "The transfer ID" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "{% admonition type=\"warning\" %}\nThis endpoint is deprecated. Use [Get a third party transfer by ID](transferthirdpartyget) (V2) instead.\n{% /admonition %}\n\nGet third party transfer info by ID. To receive dynamic updates as the state of the transfer changes, see the [webhooks documentation](/api-reference/webhook).\n" }, { "info": { "name": "Get a third party transfer by ID", "type": "http" }, "http": { "method": "GET", "url": "https://api.wise.com/v2/profiles/:profileId/third-party-transfers/:transferId", "headers": [ { "name": "X-External-Correlation-Id", "value": "f47ac10b-58cc-4372-a567-0e02b2c3d479" } ], "params": [ { "name": "profileId", "value": "", "type": "path", "description": "The profile ID" }, { "name": "transferId", "value": "", "type": "path", "description": "The transfer ID" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get third party transfer info by ID. To receive dynamic updates as the state of the transfer changes, see the [webhooks documentation](/api-reference/webhook).\n" }, { "info": { "name": "Fund a transfer", "type": "http" }, "http": { "method": "POST", "url": "https://api.wise.com/v3/profiles/:profileId/transfers/:transferId/payments", "headers": [ { "name": "X-External-Correlation-Id", "value": "f47ac10b-58cc-4372-a567-0e02b2c3d479" } ], "params": [ { "name": "profileId", "value": "", "type": "path", "description": "The profile ID that created the transfer. Can be either your personal or business profile ID" }, { "name": "transferId", "value": "", "type": "path", "description": "The transfer ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "{% admonition type=\"warning\" %}\nThis endpoint is SCA protected when it applies. If your profile is registered within the UK and/or EEA, SCA most likely applies to you.\nPlease read more about [implementing SCA](/guides/developer/auth-and-security/sca-and-2fa).\n{% /admonition %}\n\nThis API call is the final step for executing payouts when using a balance with Wise. Upon calling the endpoint, Wise will begin the processing of the transfer, depending on the status of funds.\n\nWhen using the transfer b" }, { "info": { "name": "List completed payments", "type": "http" }, "http": { "method": "GET", "url": "https://api.wise.com/v1/transfers/:transferId/payments", "headers": [ { "name": "X-External-Correlation-Id", "value": "f47ac10b-58cc-4372-a567-0e02b2c3d479" } ], "params": [ { "name": "transferId", "value": "", "type": "path", "description": "The transfer ID" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Fetch completed payments used to fund the transfer.\n\nIn most cases there should only be a single payment associated with the transfer. There are rare occasions that a transfer can be funded with multiple payment methods and when this occurs the first completed payment method would be used to calculate the fees provided on the quote.\n" }, { "info": { "name": "Get payout information", "type": "http" }, "http": { "method": "GET", "url": "https://api.wise.com/v2/transfers/:transferId/invoices/bankingpartner", "headers": [ { "name": "X-External-Correlation-Id", "value": "f47ac10b-58cc-4372-a567-0e02b2c3d479" } ], "params": [ { "name": "transferId", "value": "", "type": "path", "description": "The transfer ID" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Fetch banking reference information for transfers that are in `outgoing_payment_sent` status, enabling you to track transfers with the transfer recipient's bank.\n\nIt may take up to 3 days to get the correct information through this endpoint, as some partners don't share the information until 3 days later.\n" }, { "info": { "name": "Get a transfer receipt", "type": "http" }, "http": { "method": "GET", "url": "https://api.wise.com/v1/transfers/:transferId/receipt.pdf", "headers": [ { "name": "X-External-Correlation-Id", "value": "f47ac10b-58cc-4372-a567-0e02b2c3d479" } ], "params": [ { "name": "transferId", "value": "", "type": "path", "description": "The transfer ID" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Download transfer confirmation receipt in PDF format for transfers that are in status `outgoing_payment_sent`.\nThere's also the [transfer state change webhook](/api-reference/webhook-event/eventtransfersstatechange).\n\n{% admonition type=\"info\" %}\nIf you service US retail consumers you must use the [US combined receipt](/api-reference/transfer/transferuscombinedreceiptget) endpoint instead.\n{% /admonition %}\n" }, { "info": { "name": "Get a US combined disclosure receipt", "type": "http" }, "http": { "method": "GET", "url": "https://api.wise.com/v1/transfers/:transferId/us-combined-receipt.pdf", "headers": [ { "name": "X-External-Correlation-Id", "value": "f47ac10b-58cc-4372-a567-0e02b2c3d479" } ], "params": [ { "name": "transferId", "value": "", "type": "path", "description": "The transfer ID" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Download US combined receipt in PDF format for transfers that are in status `incoming_payment_initiated` and again when the status is updated to `outgoing_payment_sent`.\n" }, { "info": { "name": "Get a non objection certificate (INR)", "type": "http" }, "http": { "method": "GET", "url": "https://api.wise.com/v1/transfers/:transferId/documents/noc", "headers": [ { "name": "X-External-Correlation-Id", "value": "f47ac10b-58cc-4372-a567-0e02b2c3d479" } ], "params": [ { "name": "transferId", "value": "", "type": "path", "description": "The transfer ID" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Download transfer non objection certificate in PDF format for transfers that are in status `outgoing_payment_sent`.\n\nThis document can be used to obtain a Foreign Inward Remittance Certificate (FIRC) from the bank that paid out the transfer.\n\nThis is only applicable to INR payments with either a business sender or recipient.\n" }, { "info": { "name": "Create a partner licence transfer", "type": "http" }, "http": { "method": "POST", "url": "https://api.wise.com/v1/profiles/:profileId/partner-licence-transfers", "headers": [ { "name": "X-External-Correlation-Id", "value": "f47ac10b-58cc-4372-a567-0e02b2c3d479" } ], "params": [ { "name": "profileId", "value": "", "type": "path", "description": "The profile ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "{% admonition type=\"warning\" name=\"Deprecated\" %}\nThis endpoint is deprecated and only maintained for existing legacy integrations. Do not use it for new integrations. Use [Create a transfer](/api-reference/transfer/transfercreate) or [Create a third party transfer](/api-reference/transfer/transferthirdpartycreate) instead.\n{% /admonition %}\n\nThis is similar to the [Create a transfer](/api-reference/transfer/transfercreate) endpoint, but the `originator` datablock is additionally required.\n\nYou " } ] } ], "bundled": true }