{
"opencollection": "1.0.0",
"info": {
"name": "Wise Platform API"
},
"items": [
{
"info": {
"name": "3ds",
"type": "folder"
},
"items": [
{
"info": {
"name": "Inform challenge result",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v3/spend/profiles/:profileId/3dsecure/challenge-result",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "The profile ID (personal or business) associated with the 3DS challenge."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Once the customer has accepted or rejected the push notification for a 3DS challenge, you can use this endpoint to notify us of the result.\n\nYou must call this endpoint before the expiration time, otherwise it will return a 400 error. You can find the expiration information from the [3DS challenge webhook event](/guides/developer/webhooks/event-types#3ds-challenge).\n\nOnly the first call to this endpoint will be processed. Any subsequent duplicate requests will be ignored, although you will still"
}
]
},
{
"info": {
"name": "activity",
"type": "folder"
},
"items": [
{
"info": {
"name": "List Activities for a Profile",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v1/profiles/:profileId/activities",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "The unique identifier of the profile."
},
{
"name": "monetaryResourceType",
"value": "",
"type": "query",
"description": "Filter activity by resource type."
},
{
"name": "status",
"value": "",
"type": "query",
"description": "Filter by activity status."
},
{
"name": "since",
"value": "",
"type": "query",
"description": "Filter activity list after a certain timestamp. Use ISO 8601 format."
},
{
"name": "until",
"value": "",
"type": "query",
"description": "Filter activity list until a certain timestamp. Use ISO 8601 format."
},
{
"name": "nextCursor",
"value": "",
"type": "query",
"description": "Pagination cursor returned from a previous response. Use the `cursor` value from the response to fetch the next page of activities.\n"
},
{
"name": "size",
"value": "",
"type": "query",
"description": "Desired size of query. Min 1, max 100, and default value is 10 if not specified."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List of activities belonging to user profile.\n\nActivities represent snapshots of performed actions and can be filtered by various parameters to narrow down the results.\n"
}
]
},
{
"info": {
"name": "verification",
"type": "folder"
},
"items": [
{
"info": {
"name": "Upload Evidences (v3)",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v3/profiles/:profileId/additional-verification/upload-evidences",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "The unique identifier of the profile."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Uploads verification evidence for a specific profile.\n\nThe request body varies significantly between **Personal** and **Business** profiles.\n"
},
{
"info": {
"name": "Upload Evidences",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v5/profiles/:profileId/additional-verification/upload-evidences",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "The unique identifier of the profile."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Uploads verification evidence for a specific profile.\n\nThe request body varies significantly between **Personal** and **Business** profiles.\n\nSubmitting an evidence that was already uploaded will result in an attempt to update the evidence.\n"
},
{
"info": {
"name": "Upload Document",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v3/profiles/:profileId/verification-status/upload-document",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "The profile ID (personal or business)."
}
],
"body": {
"type": "multipart-form",
"data": [
{
"name": "files",
"type": "text",
"value": ""
},
{
"name": "documentType",
"type": "text",
"value": ""
}
]
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Uploads verification documents for review. You can upload multiple files at once.\n\nA valid document must fulfil these requirements:\n\n- The document must be clear.\n- The document needs to be a .jpg, .png., or .pdf file type up to 10MB in size.\n"
},
{
"info": {
"name": "Required Evidences",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v3/profiles/:profileId/verification-status/required-evidences",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "The unique identifier of the profile."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Fetches the required evidences for a profile to complete additional customer verification.\n\nIf one or more evidences are returned, the customer should submit those evidences using the upload-evidences endpoint.\n\nSee the [Supported Evidences guide](/guides/product/kyc/partner-kyc/supported-evidences) for the list of possible evidence types and how to submit them.\n"
}
]
},
{
"info": {
"name": "address",
"type": "folder"
},
"items": [
{
"info": {
"name": "List Addresses for a Profile",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v1/addresses",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profile",
"value": "12345678",
"type": "query",
"description": "The profile ID to list addresses for."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List of addresses belonging to user profile."
},
{
"info": {
"name": "Create or Update an Address",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v1/addresses",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Adds address info to user profile.\n\nList of required fields are different for different countries. Use the [address requirements endpoint](#operation/addressRequirementsGet) to dynamically discover required fields.\n\nFor updating personal profiles, consider using [the personal profile update endpoint](/api-reference/profile/profilepersonalupdate) instead. It allows submitting the address information alongside other profile data.\n\n**State field** is required for US, CA, BR, and AU addresses.\n\n**Oc"
},
{
"info": {
"name": "Retrieve an Address by ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v1/addresses/:addressId",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "addressId",
"value": "",
"type": "path",
"description": "The unique identifier of the address."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get address info by ID."
},
{
"info": {
"name": "Get Address Requirements",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v1/address-requirements",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns the list of fields required to create a valid address. Use this as a starting point to discover required fields.\n\nThe response contains 4 required top-level fields:\n- `country` (select field with list of values)\n- `city` (text field)\n- `postCode` (text field)\n- `firstLine` (text field)\n\nIf a field has `refreshRequirementsOnChange: true`, call the POST endpoint with that field's value to discover additional required fields.\n\nFor a step-by-step walkthrough, see the [Address Requirements gu"
},
{
"info": {
"name": "Get Address Requirements (with context)",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v1/address-requirements",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns the list of fields required to create a valid address, based on the provided context.\n\nUse this endpoint to dynamically discover additional required fields based on selected values. For example:\n- Posting `{\"details\": {\"country\": \"US\"}}` will add \"state\" to the list of fields.\n- Posting `{\"details\": {\"country\": \"CA\"}}` will add \"occupations\" to the list of fields.\n\nContinue calling this endpoint with field values until all fields with `refreshRequirementsOnChange: true` have been populat"
}
]
},
{
"info": {
"name": "balance",
"type": "folder"
},
"items": [
{
"info": {
"name": "List Balances for a Profile",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v4/profiles/:profileId/balances",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "The profile ID."
},
{
"name": "types",
"value": "STANDARD",
"type": "query",
"description": "Comma-separated list of balance types to return. Acceptable values are `STANDARD` and `SAVINGS`."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieves the user's multi-currency account balance accounts. Returns all balance accounts the profile has in the types specified.\n\nThe `types` parameter must include at least one type. To return more than one type, comma-separate the values.\n"
},
{
"info": {
"name": "Create a Balance Account",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v4/profiles/:profileId/balances",
"headers": [
{
"name": "X-idempotence-uuid",
"value": ""
},
{
"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": "Opens a balance within the specified profile, in the currency and type specified in the request.\n\nFor `STANDARD` balances, only one can be created per currency. For `SAVINGS` balances, multiple in the same currency can be opened.\n\nWhen creating a `SAVINGS` type balance, a `name` is required.\n"
},
{
"info": {
"name": "Retrieve a Balance by ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v4/profiles/:profileId/balances/:balanceId",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "The profile ID."
},
{
"name": "balanceId",
"value": "",
"type": "path",
"description": "The balance ID."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns a balance based on the specified balance ID."
},
{
"info": {
"name": "Remove a Balance Account",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.wise.com/v4/profiles/:profileId/balances/:balanceId",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "The profile ID."
},
{
"name": "balanceId",
"value": "",
"type": "path",
"description": "The balance ID."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Closes a balance account for the user's profile.\n\nBalance accounts must have a zero balance to be closed. Bank account details for the balance will also be deactivated and may not be restored.\n"
},
{
"info": {
"name": "Convert or Move Money Between Balances",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v2/profiles/:profileId/balance-movements",
"headers": [
{
"name": "X-idempotence-uuid",
"value": ""
},
{
"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": "This endpoint allows conversion and movement of funds between balance accounts.\n\n**Convert across balance accounts:**\nConvert funds between two `STANDARD` balance accounts in different currencies. Requires a quote created with `\"payOut\": \"BALANCE\"`.\n\n**Move money between balances:**\n- Add money to a same-currency jar (move from `STANDARD` to `SAVINGS` without conversion)\n- Add money to another-currency jar (convert money using a quote)\n- Withdraw money from a jar (move from `SAVINGS` to `STANDAR"
},
{
"info": {
"name": "Retrieve Deposit Limits",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v1/profiles/:profileId/balance-capacity",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "The profile ID."
},
{
"name": "currency",
"value": "SGD",
"type": "query",
"description": "Currency code (ISO 4217 Alphabetic Code). The deposit limit will be returned in this currency."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns the deposit limit for a profile based on regulatory requirements.\n\nUseful for personal profiles located in countries that have hold limits. We advise calling this API before depositing money into an account if the profile is located in Singapore or Malaysia.\n"
},
{
"info": {
"name": "Add an Excess Money Account",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v1/profiles/:profileId/excess-money-account",
"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": "If a balance goes over the regulatory hold limit, excess funds are automatically moved to another account at the end of the day.\n\nUse this endpoint to specify a recipient where excess money will be transferred.\n\nPrimarily used for Singapore and Malaysia customers.\n"
},
{
"info": {
"name": "Get Total Funds",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v1/profiles/:profileId/total-funds/:currency",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "The profile ID."
},
{
"name": "currency",
"value": "EUR",
"type": "path",
"description": "Currency code (ISO 4217 Alphabetic Code). All values will be converted to this currency."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Provides an overview of your account's total valuation and available liquidity across all balances.\n\nReturns total worth, total available (including overdraft), total cash, and overdraft details.\n\n#### Example (Assuming GBP and USD has 1:1 exchange rate)\n\n| Scenario | GBP balance | USD balance | Total Worth | Total Available | Overdraft Usage | Overdraft Limit |\n| ---------------------------------------- | ----------- | ----------- | ----------- | --------------- "
},
{
"info": {
"name": "Get account balance (v1)",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v1/borderless-accounts",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "33333333",
"type": "query",
"description": "Your profile ID."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "{% admonition type=\"warning\" %}\nThis endpoint is deprecated. Use the [v4 Balances endpoint](/api-reference/balance/balanceget) instead.\n{% /admonition %}\n\nGet available balances for all activated currencies in your multi-currency account.\n"
},
{
"info": {
"name": "Convert currencies between balances (v1)",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v1/borderless-accounts/:borderlessAccountId/conversions",
"headers": [
{
"name": "X-idempotence-uuid",
"value": "a1b2c3d4-e5f6-7890-abcd-ef0123456789"
},
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "borderlessAccountId",
"value": "64",
"type": "path",
"description": "Your borderless account ID."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "{% admonition type=\"warning\" %}\nThis endpoint is deprecated. Use the [balance movements endpoint](/api-reference/balance/balancemovement) to move and convert between balances instead.\n{% /admonition %}\n\nConvert funds between your multi-currency account currencies.\nQuote which is used in this call must be created with `\"payOut\": \"BALANCE\"`.\n\nNote that this call needs an extra field in header called `X-idempotence-uuid`.\n"
},
{
"info": {
"name": "List hold limit breaches",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v1/profiles/:profileId/balances/hold-limit-breach",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "The profile ID."
},
{
"name": "state",
"value": "OPEN",
"type": "query",
"description": "Filter by breach state. One of `OPEN`, `CLOSED`"
},
{
"name": "closingReason",
"value": "AUTOMATICALLY_RESOLVED",
"type": "query",
"description": "Filter by closing reason. One of `AUTOMATICALLY_RESOLVED`, `MANUALLY_RESOLVED`"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns a list of hold limit breaches for a profile. A hold limit breach occurs when a balance exceeds the regulatory hold limit for that profile's country (e.g. Singapore, Malaysia).\n\nYou can optionally filter by `state` and `closing_reason`.\n"
},
{
"info": {
"name": "Close a hold limit breach",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v1/profiles/:profileId/balances/hold-limit-breach/:holdLimitBreachId",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "The profile ID."
},
{
"name": "holdLimitBreachId",
"value": "",
"type": "path",
"description": "The hold limit breach ID."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Closes an open hold limit breach by performing a one-time refund to a specified recipient. The recipient will receive the excess amount that caused the breach.\n\nOnly breaches with `state: OPEN` can be closed via this endpoint.\n"
}
]
},
{
"info": {
"name": "balance-statement",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Balance Statement",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v1/profiles/:profileId/balance-statements/:balanceId/statement.json",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "12345",
"type": "path",
"description": "The profile ID."
},
{
"name": "balanceId",
"value": "64",
"type": "path",
"description": "The balance ID to get the statement for."
},
{
"name": "currency",
"value": "EUR",
"type": "query",
"description": "Currency of the balance statement requested (ISO 4217 Alphabetic Code)."
},
{
"name": "intervalStart",
"value": "2025-03-01T00:00:00.000Z",
"type": "query",
"description": "Statement start time in UTC."
},
{
"name": "intervalEnd",
"value": "2025-04-30T23:59:59.999Z",
"type": "query",
"description": "Statement end time in UTC."
},
{
"name": "type",
"value": "COMPACT",
"type": "query",
"description": "Statement type:\n- `COMPACT` - Single statement line per transaction\n- `FLAT` - Accounting statements where transaction fees are on a separate line\n"
},
{
"name": "statementLocale",
"value": "en",
"type": "query",
"description": "Language for the statement. Supports 2 character language codes."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve a statement for the specified balance account.\n\nThe response format depends on the URL path:\n- `statement.json` - JSON format\n- `statement.csv` - CSV format\n- `statement.pdf` - PDF format (includes Wise branding)\n- `statement.xlsx` - Excel format\n- `statement.xml` - CAMT.053 XML format\n- `statement.mt940` - MT940 format\n- `statement.qif` - QIF format\n\nThe period between `intervalStart` and `intervalEnd` cannot exceed 469 days (around 1 year 3 months).\n\n{% admonition type=\"warning\" %}\nTh"
}
]
},
{
"info": {
"name": "bank-account-details",
"type": "folder"
},
"items": [
{
"info": {
"name": "List bank account detail orders (v1)",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v1/profiles/:profileId/account-details-orders",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "The ID of the profile to list bank account detail orders for."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns the bank account assignment requests for a profile and multi-currency account.\n\n{% admonition type=\"warning\" %}\nThis endpoint is deprecated. Please use the [v3 endpoint](/api-reference/bank-account-details/bankaccountdetailsorderslist) instead.\n{% /admonition %}\n"
},
{
"info": {
"name": "Create bank account details order",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v1/profiles/:profileId/account-details-orders",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "The ID of the profile to create the bank account details order for."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Creates an order which will issue account details. It should use the same currency as the balance previously created. Fulfilling all the requirements will complete the order, reaching status `DONE`.\n\nThe possible values for a requirement status are:\n- `PENDING_USER`: The requirement has some pending action from the user.\n- `PENDING_TW`: The requirement has some pending action from Wise.\n- `DONE`: The requirement is completed.\n\nThe more common requirements are:\n- `VERIFICATION`: The user needs to"
},
{
"info": {
"name": "Create multiple bank account details",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v3/profiles/:profileId/bank-details",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "The ID of the profile to create bank account details for."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Creates and assigns a pair of local account details and international account details (where available) that are linked to the target balance specified in the request.\n\n{% admonition type=\"warning\" %}\nPlease reach out to our Support Team for access to this endpoint.\n{% /admonition %}\n"
},
{
"info": {
"name": "Retrieve bank account details",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v1/profiles/:profileId/account-details",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "The ID of the profile to retrieve bank account details for."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns a list with all the `AVAILABLE` and `ACTIVE` account details for the given profile, including examples. Account receive options can also include local and international details to receive money on the currency balance.\n\nExample bank account details are returned for any currency where bank account details have not been requested and issued. Examples will always include an `id` of `null`.\n"
},
{
"info": {
"name": "List bank account detail orders",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v3/profiles/:profileId/account-details-orders",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "The ID of the profile to list bank account detail orders for."
},
{
"name": "currency",
"value": "",
"type": "query",
"description": "Currency code (ISO 4217 Alphabetic Code)."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns the bank account assignment requests for a profile and multi-currency account.\n\nThe response includes bank-details orders in the following statuses: `PENDING_USER`, `PENDING_TW`, `REQUIREMENTS_FULFILLED`, `DONE`.\n"
},
{
"info": {
"name": "Create payment return",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v1/profiles/:profileId/account-details/payments/:paymentId/returns",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "The ID of the profile that received the payment."
},
{
"name": "paymentId",
"value": "",
"type": "path",
"description": "The ID of the payment to return."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Creates a return for a payment received to bank account details.\n\nWhen you create a return, you must provide the ID of the payment you wish to return as well as the ID of the profile that received the payment. In addition, you can provide a `reason` for the return in the request body. When returning SWIFT payments, `reason` is a required field.\n"
}
]
},
{
"info": {
"name": "batch-group",
"type": "folder"
},
"items": [
{
"info": {
"name": "Create a batch group",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v3/profiles/:profileId/batch-groups",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "The ID of the profile to create the batch group for."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create a new batch group.\n\nA batch group can hold up to 1000 transfers that will be funded together. After creating the group, add transfers to it, then complete the group to receive pay-in details.\n"
},
{
"info": {
"name": "Retrieve a batch group",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v3/profiles/:profileId/batch-groups/:batchGroupId",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "The ID of the profile that the batch group is associated with."
},
{
"name": "batchGroupId",
"value": "",
"type": "path",
"description": "The batch group ID."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get an existing batch group by ID.\n"
},
{
"info": {
"name": "Update batch group status",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.wise.com/v3/profiles/:profileId/batch-groups/:batchGroupId",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "The ID of the profile that the batch group is associated with."
},
{
"name": "batchGroupId",
"value": "",
"type": "path",
"description": "The batch group ID."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update a batch group's status to complete or cancel it.\n\n**Complete a batch group:** Set `status` to `COMPLETED` to close the group for modifications and allow funding to proceed. Once completed, `payInDetails` will be populated with funding instructions.\n\n**Cancel a batch group:** Set `status` to `CANCELLED` to cancel all transfers in the batch. Only batches that are not funded can be cancelled. Cancellation is final and cannot be undone.\n\nThe `version` parameter is required for concurrency con"
},
{
"info": {
"name": "Create a batch group transfer",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v3/profiles/:profileId/batch-groups/:batchGroupId/transfers",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "The ID of the profile that the batch group is associated with."
},
{
"name": "batchGroupId",
"value": "",
"type": "path",
"description": "The batch group ID."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create a transfer in the batch group using a previously created recipient account and quote.\n\nFor the request body format, see [transfer creation](/api-reference/transfer#create). For quote and recipient creation, see [quote creation](/api-reference/quote/quotecreate) and [recipient creation](/api-reference/recipient/recipientcreate).\n"
},
{
"info": {
"name": "Fund a batch group",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v3/profiles/:profileId/batch-payments/:batchGroupId/payments",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "The ID of the profile that the batch group is associated with."
},
{
"name": "batchGroupId",
"value": "",
"type": "path",
"description": "The batch group ID."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Funds all transfers in a batch group from a multi-currency account balance. Transfers are paid out immediately.\n\nThe batch group must first be completed, and there must be enough funds in the account for the whole batch. Otherwise, an insufficient funds error will be returned.\n\n{% 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. For more information, please read [implementing SCA]("
},
{
"info": {
"name": "Fund a batch group via direct debit",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v1/profiles/:profileId/batch-groups/:batchGroupId/payment-initiations",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "The ID of the profile that the batch group is associated with."
},
{
"name": "batchGroupId",
"value": "",
"type": "path",
"description": "The batch group ID."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Funds all transfers in a batch group via direct debit. The batch group must be in the `COMPLETED` state.\n\nTo use this funding method, you need to link an external bank account first. See [direct debit account creation](/api-reference/direct-debit-account/directdebitaccountcreate) for more information.\n\n{% 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. For more information, please"
},
{
"info": {
"name": "Retrieve a payment initiation",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v1/profiles/:profileId/batch-groups/:batchGroupId/payment-initiations/:paymentInitiationId",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "The ID of the profile that the batch group is associated with."
},
{
"name": "batchGroupId",
"value": "",
"type": "path",
"description": "The batch group ID."
},
{
"name": "paymentInitiationId",
"value": "",
"type": "path",
"description": "The payment initiation ID."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get payment initiation info by ID. In addition to [webhooks](/guides/developer/webhooks/event-types#batch-payment-initiations-state-change-event), this endpoint can be used for polling the status of a payment initiation.\n"
}
]
},
{
"info": {
"name": "bulk-settlement",
"type": "folder"
},
"items": [
{
"info": {
"name": "Send a settlement journal",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v1/settlements",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Sends the settlement journal to Wise. There are two types of settlement:\n\n- **Same Currency Settlement** — Settle in the same currency as the transfers (e.g., settle USD transfers with USD).\n- **Cross Currency Settlement** — Settle in a different currency (e.g., settle PHP transfers with USD). In this case, you must specify `settlementCurrency` and include `exchangeRate` on every transfer.\n\n{% admonition type=\"info\" %}\nYou must use a client credentials token to authenticate this call.\n{% /admoni"
}
]
},
{
"info": {
"name": "card",
"type": "folder"
},
"items": [
{
"info": {
"name": "List cards for a profile",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v3/spend/profiles/:profileId/cards",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "123456",
"type": "path",
"description": "The ID of the profile to retrieve cards for."
},
{
"name": "pageSize",
"value": "10",
"type": "query",
"description": "The maximum number of cards to return per page. Must be between 10 and 100."
},
{
"name": "pageNumber",
"value": "1",
"type": "query",
"description": "The page number to retrieve. Must be greater than or equal to 1."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns a paginated list of cards that belong to a specific profile.\n"
},
{
"info": {
"name": "Get card details",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v3/spend/profiles/:profileId/cards/:cardToken",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "123456",
"type": "path",
"description": "The ID of the profile that owns the card."
},
{
"name": "cardToken",
"value": "ca0c8154-1e14-4464-a1ce-dcea7dc3de52",
"type": "path",
"description": "The unique token identifying the card."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieves details for a specific card by its token.\n"
},
{
"info": {
"name": "Update card status",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.wise.com/v3/spend/profiles/:profileId/cards/:cardToken/status",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "123456",
"type": "path",
"description": "The ID of the profile that owns the card."
},
{
"name": "cardToken",
"value": "ca0c8154-1e14-4464-a1ce-dcea7dc3de52",
"type": "path",
"description": "The unique token identifying the card."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update the status of a card. For cards issued with an `INACTIVE` status, updating to `ACTIVE` will activate the card and move the card order status to `COMPLETED`.\n\n**Available status transitions:**\n- `ACTIVE` - The card is active and usable\n- `FROZEN` - The card is temporarily frozen; all authorization requests will be declined\n- `BLOCKED` - The card is **irreversibly** blocked and is no longer usable\n"
},
{
"info": {
"name": "Reset PIN count",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v3/spend/profiles/:profileId/cards/:cardToken/reset-pin-count",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "123456",
"type": "path",
"description": "The ID of the profile that owns the card."
},
{
"name": "cardToken",
"value": "ca0c8154-1e14-4464-a1ce-dcea7dc3de52",
"type": "path",
"description": "The unique token identifying the card."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "If the wrong PIN has been entered more than 3 times, future transactions on the card will be blocked with a `PIN_ENTRY_TRIES_EXCEEDED` error message.\n\nUse this endpoint to reset the PIN count to 0 and unblock transactions.\n\n{% admonition type=\"info\" %}\nIn some cases, you may also need to reset the PIN count directly at the ATM.\n{% /admonition %}\n"
},
{
"info": {
"name": "Get card spending permissions",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v3/spend/profiles/:profileId/cards/:cardToken/spending-permissions",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "123456",
"type": "path",
"description": "The ID of the profile that owns the card."
},
{
"name": "cardToken",
"value": "ca0c8154-1e14-4464-a1ce-dcea7dc3de52",
"type": "path",
"description": "The unique token identifying the card."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieves the current spending permissions configured for a card.\n"
},
{
"info": {
"name": "Update a single card permission",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.wise.com/v3/spend/profiles/:profileId/cards/:cardToken/spending-permissions",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "123456",
"type": "path",
"description": "The ID of the profile that owns the card."
},
{
"name": "cardToken",
"value": "ca0c8154-1e14-4464-a1ce-dcea7dc3de52",
"type": "path",
"description": "The unique token identifying the card."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Enable or disable a single spending permission on a card.\n\n{% admonition type=\"warning\" %}\nThis endpoint is deprecated. Please use the [v4 endpoint](/api-reference/card/cardpermissionsbulkupdate) instead.\n{% /admonition %}\n"
},
{
"info": {
"name": "Bulk update card permissions",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.wise.com/v4/spend/profiles/:profileId/cards/:cardToken/spending-permissions",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "123456",
"type": "path",
"description": "The ID of the profile that owns the card."
},
{
"name": "cardToken",
"value": "ca0c8154-1e14-4464-a1ce-dcea7dc3de52",
"type": "path",
"description": "The unique token identifying the card."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Enable or disable multiple spending permissions on a card in a single request.\n\nThis is the recommended endpoint for updating card permissions as it allows updating multiple permissions atomically.\n"
},
{
"info": {
"name": "Update phone number",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.wise.com/v3/spend/profiles/:profileId/cards/:cardToken/phone-number",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "30000000",
"type": "path",
"description": "Your profile ID."
},
{
"name": "cardToken",
"value": "12345-12345-12345-12345",
"type": "path",
"description": "The card token."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "{% admonition type=\"warning\" %}\nThis endpoint is deprecated for partners onboarded after 1/3/2025. For new and existing partners, your clientId will need to be approved by our support team to make the `phoneNumber` optional in the [create card order endpoint](/api-reference/card-order/cardordercreate). See [3DS for more information](/guides/product/issue-cards/3ds).\n{% /admonition %}\n\nUpdates the phone number of a card. The new phone number must be a valid phone number.\n"
}
]
},
{
"info": {
"name": "card-sensitive-details",
"type": "folder"
},
"items": [
{
"info": {
"name": "Fetch RSA encryption key",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/twcard-data/v1/clientSideEncryption/fetchEncryptingKey",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Fetches Wise's RSA public key required for encrypting sensitive card data requests.\n\nThis key is used in the [sensitive card details flow](/guides/product/issue-cards/sensitive-card-details) to create JWE (JSON Web Encryption) payloads.\n"
},
{
"info": {
"name": "Get sensitive card details",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/twcard-data/v1/sensitive-card-data/details",
"headers": [
{
"name": "x-tw-twcard-card-token",
"value": "ca0c8154-1e14-4464-a1ce-dcea7dc3de52"
},
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Fetches the card's Primary Account Number (PAN), security code (CVV2), expiry date, and cardholder name.\n\nRequires an encrypted JWE payload for security. See the [sensitive card details guide](/guides/product/issue-cards/sensitive-card-details) for implementation details.\n\nTo retrieve sensitive card details, the card must be in either `ACTIVE` or `FROZEN` status. A 403 response will be returned for cards in any other status.\n\n{% admonition type=\"warning\" %}\nThis endpoint is SCA protected when ap"
},
{
"info": {
"name": "Get card PIN",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/twcard-data/v1/sensitive-card-data/pin",
"headers": [
{
"name": "x-tw-twcard-card-token",
"value": "ca0c8154-1e14-4464-a1ce-dcea7dc3de52"
},
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Fetches the card's PIN.\n\nRequires an encrypted JWE payload for security. See the [sensitive card details guide](/guides/product/issue-cards/sensitive-card-details) for implementation details.\n\n{% admonition type=\"warning\" %}\nThis endpoint is SCA protected when applicable. If your profile is registered within the UK and/or EEA, SCA most likely applies. For more information, see [implementing SCA](/guides/developer/auth-and-security/sca-and-2fa).\n{% /admonition %}\n"
}
]
},
{
"info": {
"name": "card-kiosk-collection",
"type": "folder"
},
"items": [
{
"info": {
"name": "Retrieve card production status",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v3/spend/profiles/:profileId/cards/:cardToken/production",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "123456",
"type": "path",
"description": "The profile ID (personal or business) that owns the card."
},
{
"name": "cardToken",
"value": "ca0c8154-1e14-4464-a1ce-dcea7dc3de52",
"type": "path",
"description": "The unique token identifying the card."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieves the current production status of a card at a kiosk machine.\n\n**Best practice**: Subscribe to the [card production status change](/guides/developer/webhooks/event-types#cards-card-production-status-change) webhook for real-time notifications. Use this endpoint only when you need to synchronously check the status.\n"
},
{
"info": {
"name": "Produce a card",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.wise.com/v3/spend/profiles/:profileId/cards/:cardToken/production",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "123456",
"type": "path",
"description": "The profile ID (personal or business) that owns the card."
},
{
"name": "cardToken",
"value": "ca0c8154-1e14-4464-a1ce-dcea7dc3de52",
"type": "path",
"description": "The unique token identifying the card."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Sends the card production request to a kiosk machine. To confirm that card information has been successfully created, listen to the [card-production-status-change](/guides/developer/webhooks/event-types#cards-card-production-status-change) webhook with status `READY`.\n\n{% admonition type=\"warning\" %}\nCards that were created over 60 days ago will result in a 422 error code and cannot be retried. This is due to the data being obfuscated on our side. In this case, a new card order has to be created"
}
]
},
{
"info": {
"name": "card-order",
"type": "folder"
},
"items": [
{
"info": {
"name": "Retrieve all card orders",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v3/spend/profiles/:profileId/card-orders",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "123456",
"type": "path",
"description": "The profile ID (personal or business)."
},
{
"name": "pageSize",
"value": "10",
"type": "query",
"description": "The maximum number of card orders to return per page. This number can be between 10 - 100, and will default to 10."
},
{
"name": "pageNumber",
"value": "1",
"type": "query",
"description": "The page number to retrieve the next set of card orders. The number has to be greater or equal to 1, and will default to 1."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieves a list of card orders created for the specified `profileId`."
},
{
"info": {
"name": "Create a card order",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v3/spend/profiles/:profileId/card-orders",
"headers": [
{
"name": "X-idempotence-uuid",
"value": "054064c9-e01e-49fb-8fd9-b0990b9442f4"
},
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "123456",
"type": "path",
"description": "The profile ID (personal or business)."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Creates a new card order. The `program` field value is retrieved from the [retrieve all card programs](/api-reference/card-order/cardorderprogramsget) endpoint.\n\n{% admonition type=\"warning\" %}\nThis request requires an extra field in the header, `X-idempotence-uuid`. This should be generated and used for any subsequent retries in the event that the initial request fails.\n{% /admonition %}\n\nWhen you issue a card under a business profile, the cardholder will automatically default to the [business "
},
{
"info": {
"name": "Retrieve a card order",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v3/spend/profiles/:profileId/card-orders/:cardOrderId",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "123456",
"type": "path",
"description": "The profile ID (personal or business)."
},
{
"name": "cardOrderId",
"value": "142",
"type": "path",
"description": "The card order ID."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieves a card order based on the `cardOrderId`."
},
{
"info": {
"name": "Retrieve available card programs",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v3/spend/profiles/:profileId/card-orders/availability",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "123456",
"type": "path",
"description": "The profile ID (personal or business)."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieves the list of available card programs for each `profileId`."
},
{
"info": {
"name": "Retrieve card order requirements",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v3/spend/profiles/:profileId/card-orders/:cardOrderId/requirements",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "123456",
"type": "path",
"description": "The profile ID (personal or business)."
},
{
"name": "cardOrderId",
"value": "142",
"type": "path",
"description": "The card order ID."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieves all card requirements for a `cardOrderId`. A valid card order needs all its requirements status to be `COMPLETED`.\n\nThe type of requirements are:\n- `PIN (optional)`: [Set a PIN](/api-reference/card-order/cardorderpresetpin) on a virtual or physical card order. Contact the team if you need this feature.\n- `VERIFICATION`: Verify your customer by providing KYC evidences. Refer to the [KYC guide](/guides/product/kyc).\n- `ADDRESS`: Provide a valid address for your card order. Refer to [addr"
},
{
"info": {
"name": "Update card order status",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.wise.com/v3/spend/profiles/:profileId/card-orders/:cardOrderId/status",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "123456",
"type": "path",
"description": "The profile ID (personal or business)."
},
{
"name": "cardOrderId",
"value": "142",
"type": "path",
"description": "The card order ID."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Updates the status of a card order based on its `cardOrderId`. The status can be updated to one of the following:\n1. `CANCELLED`\n2. `COMPLETED` (deprecated)\n\nThe behaviour for card order cancellation differs across card order statuses:\n- `PLACED`: Card order can be cancelled with no further action required.\n- `REQUIREMENTS_FULFILLED`, `CARD_DETAILS_CREATED`, `PRODUCED`: Card order can be cancelled, and its associated card will be blocked. However, the physical card may have already been produced"
},
{
"info": {
"name": "Validate an address",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v3/spend/address/validate",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Validates the format of an address for a card order. Make sure to follow country-specific address fields and validation as described in the [card address validation guide](/guides/developer/api-guides/card-address-validation).\n\nFor virtual cards, the address field will be used as a billing address. It will be used for AVS checks in countries where it is required.\n\nFor physical cards, the address field will be used as a delivery address. It will be used to deliver your card and for AVS checks in "
},
{
"info": {
"name": "Set card PIN",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/twcard-data/v1/sensitive-card-data/preset-pin",
"headers": [
{
"name": "x-tw-twcard-order-id",
"value": "142"
},
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Sets a PIN during the card order flow. This endpoint will be accessible for partners that require to set a PIN during the card order flow.\n\nPlease follow [this guide](/guides/product/issue-cards/sensitive-card-details) to use this endpoint.\n\nTo use this endpoint, make sure to set the `api token` and the `card order id` in the headers.\n"
}
]
},
{
"info": {
"name": "card-transaction",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get card transaction (V3)",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v3/spend/profiles/:profileId/cards/transactions/:transactionId",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "123456",
"type": "path",
"description": "The ID of the profile that owns the card."
},
{
"name": "transactionId",
"value": "342671",
"type": "path",
"description": "The ID of the transaction."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "{% admonition type=\"warning\" %}\nThis endpoint is deprecated. Use the [V4 Get card transaction](/api-reference/card-transaction/cardtransactionget) endpoint instead.\n{% /admonition %}\n\nRetrieve a card transaction by its ID.\n\nUse in conjunction with the [V2.0.0 card transaction state change webhook](/guides/developer/webhooks/event-types#cards-transaction-state-change).\n\nWhen a refund happens, a separate transaction will be added with a `REFUND` transaction type.\n"
},
{
"info": {
"name": "Get card transaction",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v4/spend/profiles/:profileId/cards/transactions/:transactionId",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "123456",
"type": "path",
"description": "The ID of the profile that owns the card."
},
{
"name": "transactionId",
"value": "342671",
"type": "path",
"description": "The ID of the transaction."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve a card transaction by its ID.\n\nUse in conjunction with the [card transaction state change webhook](/guides/developer/webhooks/event-types#cards-transaction-state-change) for versions V2.1.0 and later.\n\n{% admonition type=\"warning\" %}\nOnly transactions created in the past 90 days can be accessed. A 422 error code will be returned otherwise.\n{% /admonition %}\n\nWhen a refund happens, a separate transaction will be added with a `REFUND` transaction type.\n"
},
{
"info": {
"name": "List card transactions",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v4/spend/profiles/:profileId/cards/:cardToken/transactions",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "123456",
"type": "path",
"description": "The ID of the profile that owns the card."
},
{
"name": "cardToken",
"value": "59123122-223d-45f9-b840-0ad4a4f80937",
"type": "path",
"description": "The unique token identifying the card."
},
{
"name": "fromCreationTime",
"value": "2025-12-15T00:00:00Z",
"type": "query",
"description": "Start of range for transaction creation time in UTC, in ISO-8601 format."
},
{
"name": "toCreationTime",
"value": "2026-01-15T00:00:10Z",
"type": "query",
"description": "End of range for transaction creation time in UTC, in ISO-8601 format."
},
{
"name": "pageSize",
"value": "10",
"type": "query",
"description": "Page size of query between 10 and 100 inclusive, defaults to 20."
},
{
"name": "lastId",
"value": "342672",
"type": "query",
"description": "A pagination cursor that marks your position in the list. Include the ID of the last transaction from the previous page to retrieve the next page (transactions with IDs less than the provided value)."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve a list of card transactions for a specific card. Transactions are ordered by transaction ID in descending order.\n\nUse in conjunction with the [card transaction state change webhook](/guides/developer/webhooks/event-types#cards-transaction-state-change) for versions V2.1.0 and later.\n\n{% admonition type=\"warning\" %}\nOnly transactions created in the past 90 days can be accessed. A 422 error code will be returned otherwise.\n{% /admonition %}\n\nThe `debits` and `credits` fields are not inclu"
}
]
},
{
"info": {
"name": "claim-account",
"type": "folder"
},
"items": [
{
"info": {
"name": "Generate a claim account code",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v1/user/claim-account",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Generate a short-lived `claim_account_code` that allows a customer to take ownership of an account. Use the code when [redirecting the customer to Wise](/guides/product/kyc/wise-kyc/redirect-to-wise/claim-account) to finalize their account setup.\n"
}
]
},
{
"info": {
"name": "comparison",
"type": "folder"
},
"items": [
{
"info": {
"name": "Request a comparison quote (V3)",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v3/comparisons",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "sourceCurrency",
"value": "GBP",
"type": "query",
"description": "ISO 4217 source currency code"
},
{
"name": "targetCurrency",
"value": "EUR",
"type": "query",
"description": "ISO 4217 target currency code"
},
{
"name": "sendAmount",
"value": "10000",
"type": "query",
"description": "Amount to send in source currency"
},
{
"name": "midMarketRate",
"value": "",
"type": "query",
"description": "Current mid-market rate between the source and target currency"
},
{
"name": "wiseFee",
"value": "",
"type": "query",
"description": "Wise's fee, if the Wise quote is known"
},
{
"name": "wiseEstimatedDelivery",
"value": "",
"type": "query",
"description": "Wise's estimated delivery timestamp, if the Wise quote is known"
},
{
"name": "wiseQuoteCreatedTime",
"value": "",
"type": "query",
"description": "Timestamp when the Wise quote was created"
},
{
"name": "payInMethod",
"value": "",
"type": "query",
"description": "Change the pay-in method of the Wise quote only (all other quotes will remain as bank transfer)"
},
{
"name": "sourceCountry",
"value": "",
"type": "query",
"description": "Filter by source country (ISO 3166-1 Alpha-2 code)"
},
{
"name": "targetCountry",
"value": "",
"type": "query",
"description": "Filter by target country (ISO 3166-1 Alpha-2 code)"
},
{
"name": "providerCountry",
"value": "",
"type": "query",
"description": "Filter by provider country (ISO 3166-1 Alpha-2 code)"
},
{
"name": "providerTypes",
"value": "",
"type": "query",
"description": "Filter by provider type"
},
{
"name": "providers",
"value": "",
"type": "query",
"description": "Filter by specific provider aliases"
},
{
"name": "excludePartners",
"value": "",
"type": "query",
"description": "Exclude Wise's partner banks - default true"
}
]
},
"docs": "{% admonition type=\"warning\" name=\"Deprecated\" %}\nThis endpoint is deprecated. Use the [V4 comparison endpoint](/api-reference/comparison/comparisonget) instead.\n{% /admonition %}\n\nRequest price and speed comparison data for money transfer providers on a given currency route.\n"
},
{
"info": {
"name": "Request a comparison quote",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v4/comparisons",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "sourceCurrency",
"value": "GBP",
"type": "query",
"description": "ISO 4217 source currency code"
},
{
"name": "targetCurrency",
"value": "EUR",
"type": "query",
"description": "ISO 4217 target currency code"
},
{
"name": "sendAmount",
"value": "10000",
"type": "query",
"description": "Amount to send in source currency. Must provide either `sendAmount` or `recipientGetsAmount`."
},
{
"name": "recipientGetsAmount",
"value": "",
"type": "query",
"description": "Amount to be received in target currency. Must provide either `sendAmount` or `recipientGetsAmount`."
},
{
"name": "midMarketRate",
"value": "",
"type": "query",
"description": "Current mid-market rate between the source and target currency"
},
{
"name": "wiseFee",
"value": "",
"type": "query",
"description": "Wise's fee, if the Wise quote is known"
},
{
"name": "wiseEstimatedDelivery",
"value": "",
"type": "query",
"description": "Wise's estimated delivery timestamp, if the Wise quote is known"
},
{
"name": "wiseQuoteCreatedTime",
"value": "",
"type": "query",
"description": "Timestamp when the Wise quote was created"
},
{
"name": "payInMethod",
"value": "",
"type": "query",
"description": "Change the pay-in method of the Wise quote only (all other quotes will remain as bank transfer)"
},
{
"name": "sourceCountry",
"value": "",
"type": "query",
"description": "Filter by source country (ISO 3166-1 Alpha-2 code)"
},
{
"name": "targetCountry",
"value": "",
"type": "query",
"description": "Filter by target country (ISO 3166-1 Alpha-2 code)"
},
{
"name": "providerCountry",
"value": "",
"type": "query",
"description": "Filter by provider country (ISO 3166-1 Alpha-2 code)"
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "Filter by most popular competitors"
},
{
"name": "numberOfProviders",
"value": "",
"type": "query",
"description": "Number of popular competitors to return if `filter` is set to `POPULAR` - default value is 4"
},
{
"name": "providerTypes",
"value": "",
"type": "query",
"description": "Filter by provider type"
},
{
"name": "providers",
"value": "",
"type": "query",
"description": "Filter by specific provider aliases"
},
{
"name": "excludePartners",
"value": "",
"type": "query",
"description": "Exclude Wise's partner banks - default true"
},
{
"name": "includeWise",
"value": "",
"type": "query",
"description": "Overrides filters to ensure Wise data is returned, even if exclusionary filters are applied"
}
]
},
"docs": "Request price and speed comparison data for money transfer providers on a given currency route.\n\nYou must provide either `sendAmount` or `recipientGetsAmount` (but not both).\n"
}
]
},
{
"info": {
"name": "contact",
"type": "folder"
},
"items": [
{
"info": {
"name": "Create a contact from an identifier",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v2/profiles/:profileId/contacts",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "12345678",
"type": "path",
"description": "Your profile ID."
},
{
"name": "isDirectIdentifierCreation",
"value": "true",
"type": "query",
"description": "Must be set to `true` for identifier-based contact creation."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Finds an existing **discoverable** Wise profile and adds it to your recipient list. The recipient is found by an identifier — such as a Wisetag, email, or phone number — without needing bank details. Use the `contactId` from the response to create a transfer.\n"
}
]
},
{
"info": {
"name": "currencies",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get all currencies allowed for transfers",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v1/currencies",
"headers": [
{
"name": "Accept-Language",
"value": "en"
},
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns all currencies available for creating transfers. Currency names are returned in English by default — pass an `Accept-Language` header to receive localized names.\n"
}
]
},
{
"info": {
"name": "delivery-estimate",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get the delivery estimate for a transfer",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v1/delivery-estimates/:transferId",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "transferId",
"value": "12345678",
"type": "path",
"description": "The ID of the transfer."
},
{
"name": "timezone",
"value": "Asia/Singapore",
"type": "query",
"description": "Timezone ID for the formatted text. Defaults to `UTC` if not provided."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get the live delivery estimate for a transfer by the transfer ID.\n\nThe delivery estimate is the time at which we currently expect the transfer to arrive in the beneficiary's bank account. This is not a guaranteed time but we are working hard to make these estimates as accurate as possible.\n"
}
]
},
{
"info": {
"name": "direct-debit-account",
"type": "folder"
},
"items": [
{
"info": {
"name": "Retrieve all direct debit accounts",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v1/profiles/:profileId/direct-debit-accounts",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "12345678",
"type": "path",
"description": "Your profile ID."
},
{
"name": "type",
"value": "ACH",
"type": "query",
"description": "Payment type for which the account is used.\n\n- `ACH` — US direct debit (USD)\n- `EFT` — CA direct debit (CAD)\n"
},
{
"name": "currency",
"value": "USD",
"type": "query",
"description": "Currency of the bank account. 3-character currency code — `USD` for ACH direct debits, `CAD` for EFT direct debits."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get a list of your direct debit accounts. Use the `type` and `currency` query parameters to filter accounts.\n"
},
{
"info": {
"name": "Create a direct debit account",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v1/profiles/:profileId/direct-debit-accounts",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "12345678",
"type": "path",
"description": "Your profile ID."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Register a new external bank account for funding batch transfers via direct debit.\n"
}
]
},
{
"info": {
"name": "disputes",
"type": "folder"
},
"items": [
{
"info": {
"name": "Dispute dynamic flow entry point",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v3/spend/profiles/:profileId/dispute-form/flows/step/:scheme/:reason",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "14547572",
"type": "path",
"description": "Your profile ID."
},
{
"name": "scheme",
"value": "VISA",
"type": "path",
"description": "The network of the card that was used to make this transaction."
},
{
"name": "reason",
"value": "TROUBLE_WITH_GOODS_SERVICES",
"type": "path",
"description": "Dispute reason code supplied by the [dispute reasons endpoint](/api-reference/disputes/disputereasonsget)."
},
{
"name": "transactionId",
"value": "6789",
"type": "query",
"description": "The ID of the transaction being disputed. Can be a comma-separated list of IDs if the reason code has the `supportsMultipleTransactions` flag."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieves the JSON for initiating the dispute flow. Use this endpoint with Wise's\n[Dynamic Flow framework](https://www.npmjs.com/package/@transferwise/dynamic-flows).\n\nThe JSON response must be passed into the Dynamic Flow framework, which handles the multi-step dispute submission including the generation of subsequent pages and the creation of the dispute.\n\n**Setting up the API**\n\nYou will need to implement a GET API with the following format:\n`GET https://{{yourApiUrl}}/v3/spend/profiles/{{pro"
},
{
"info": {
"name": "Retrieve dispute reasons",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v3/spend/profiles/:profileId/dispute-form/reasons",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "14547572",
"type": "path",
"description": "Your profile ID."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieves the list of possible reasons for submitting a dispute.\n\nIf a reason code has `subOptions`, those should be used as the reason code when submitting disputes.\n"
},
{
"info": {
"name": "Submit dispute",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v3/spend/profiles/:profileId/dispute-form/flows/:scheme/:reason",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "14547572",
"type": "path",
"description": "Your profile ID."
},
{
"name": "scheme",
"value": "VISA",
"type": "path",
"description": "The network of the card that was used to make this transaction."
},
{
"name": "reason",
"value": "WRONG_AMOUNT",
"type": "path",
"description": "Dispute reason code supplied by the [dispute reasons endpoint](/api-reference/disputes/disputereasonsget)."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Submit a dispute for a card transaction.\n\nThe request body structure varies per dispute reason code. All reasons share a common structure with `transaction`, `form`, `disclaimer`, and `files` objects, but the fields within `form` and `files` differ per reason.\n\nFor per-reason request body details, see the [disputes via API guide](/guides/product/issue-cards/card-disputes-api#reason-examples).\n"
},
{
"info": {
"name": "Upload dispute file",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v4/spend/profiles/:profileId/dispute-form/file",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "14547572",
"type": "path",
"description": "Your profile ID."
}
],
"body": {
"type": "multipart-form",
"data": [
{
"name": "receipt",
"type": "text",
"value": ""
}
]
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Upload a file for use in a dispute submission. Use the returned file ID in the `files` object when submitting a dispute.\n\nA dispute referencing the returned file ID must be submitted no later than **two hours** after the file upload, otherwise the file will expire and must be re-uploaded.\n"
},
{
"info": {
"name": "List disputes",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v3/spend/profiles/:profileId/disputes",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "16605997",
"type": "path",
"description": "Your profile ID."
},
{
"name": "status",
"value": "ACTIVE",
"type": "query",
"description": "Filter by dispute status."
},
{
"name": "transactionId",
"value": "2040",
"type": "query",
"description": "Filter by card transaction ID."
},
{
"name": "pageSize",
"value": "10",
"type": "query",
"description": "The maximum number of disputes to return per page. Between 10 and 100, defaults to 10."
},
{
"name": "pageNumber",
"value": "1",
"type": "query",
"description": "The page number to retrieve. Must be at least 1, defaults to 1."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List disputes for a profile with optional filters.\n"
},
{
"info": {
"name": "Get dispute",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v3/spend/profiles/:profileId/disputes/:disputeId",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "16605997",
"type": "path",
"description": "Your profile ID."
},
{
"name": "disputeId",
"value": "51e2dc60-9e4b-4ff5-b917-b90cc5e1ecfb",
"type": "path",
"description": "The dispute ID."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve a dispute by its ID.\n"
},
{
"info": {
"name": "Withdraw dispute",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.wise.com/v3/spend/profiles/:profileId/disputes/:disputeId/status",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "16605997",
"type": "path",
"description": "Your profile ID."
},
{
"name": "disputeId",
"value": "51e2dc60-9e4b-4ff5-b917-b90cc5e1ecfb",
"type": "path",
"description": "The dispute ID."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Withdraw a dispute by setting its status to `CLOSED`.\n\nYou can only withdraw a dispute if `canWithdraw` is `true` on the dispute resource.\n"
},
{
"info": {
"name": "Upload dispute file (v3)",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v3/spend/profiles/:profileId/dispute-form/file",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "14547572",
"type": "path",
"description": "Your profile ID."
}
],
"body": {
"type": "multipart-form",
"data": [
{
"name": "receipt",
"type": "text",
"value": ""
}
]
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "{% admonition type=\"warning\" %}\nThis endpoint is deprecated. Use the [v4 upload dispute file endpoint](/api-reference/disputes/disputefileupload) instead.\n{% /admonition %}\n\nSubmit a file for disputes.\n\nThis API is not available for sandbox testing.\n\nUse the `fileId` in the response for the dispute submission.\n\n**NB:** A dispute referencing the returned `fileId` must be submitted no later than **two hours** after the file submission, otherwise the file will expire and must be re-submitted.\n"
}
]
},
{
"info": {
"name": "facetec",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get FaceTec public key",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v1/facetec/public-key",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve Wise's FaceTec public key to be used when [exporting 3D FaceMap](https://dev.facetec.com/api-guide#export-3d-facemap) from your FaceTec host to Wise.\n\nThe exported FaceMap can be used to [Enrol FaceMap](/api-reference/user-security/usersecurityfacemapenrol).\n"
}
]
},
{
"info": {
"name": "jose",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Wise JOSE public key",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v1/auth/jose/response/public-keys",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "version",
"value": "",
"type": "query",
"description": "Fetch a specific public key version. If omitted the most recent public key is provided."
},
{
"name": "algorithm",
"value": "ES512",
"type": "query",
"description": "Algorithm to be used for signature verification or payload encryption. This must match the algorithm used during request.\n\n- Signature verification (Scope: `PAYLOAD_SIGNING`): `ES256`, `ES384`, `ES512`, `PS256`, `PS384`, `PS512`\n- Payload encryption (Scope: `PAYLOAD_ENCRYPTION`): `RSA_OAEP_256`\n"
},
{
"name": "scope",
"value": "PAYLOAD_SIGNING",
"type": "query",
"description": "Scope of the key. Must be `PAYLOAD_SIGNING` or `PAYLOAD_ENCRYPTION`."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns a public key issued by Wise.\n\nDepending on the scope requested, the key will be used for verifying HTTP responses signed by Wise or for for encrypting the payload prior to sending it to Wise.\n\nFor both signature verification and payload encryption, the process involves storing this public key after retrieval. In both cases, the stored public key should be used without calling this endpoint.\n\nIf verification of the signed request fails or Wise is unable to decrypt your request payload, ca"
},
{
"info": {
"name": "Add a new client public key",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v1/auth/jose/request/public-keys",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Upload a client public key for request payload signing or response payload encryption.\n\n{% admonition type=\"warning\" %}\n This endpoint requires a client credentials token, not a user level access token. Make sure you use your client details to fetch a valid [client credentials token](/api-reference/oauth-token/oauthtokencreate) before performing this call.\n{% /admonition %}\n"
},
{
"info": {
"name": "Playground JWS",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v1/auth/jose/playground/jws",
"headers": [
{
"name": "Accept",
"value": "application/jose+json"
},
{
"name": "x-tw-jose-method",
"value": "jws"
},
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Send test signed HTTP requests and receive signed responses. Signing is mandatory for this endpoint — any message that is not a JSON Web Signature (JWS) will be rejected.\n"
},
{
"info": {
"name": "Playground JWE for GET requests",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v1/auth/jose/playground/jwe",
"headers": [
{
"name": "Accept",
"value": "application/jose+json"
},
{
"name": "x-tw-jose-method",
"value": "jwe"
},
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Send test HTTP GET requests and receive encrypted responses.\n"
},
{
"info": {
"name": "Playground JWE for POST requests",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v1/auth/jose/playground/jwe",
"headers": [
{
"name": "Accept",
"value": "application/jose+json"
},
{
"name": "x-tw-jose-method",
"value": "jwe"
},
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Send test encrypted HTTP requests and receive encrypted responses. Encryption is mandatory for this endpoint — any message that is not in JSON Web Encryption (JWE) format will be rejected.\n"
},
{
"info": {
"name": "Playground JWE for direct encryption",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v1/auth/jose/playground/jwe-direct-encryption",
"headers": [
{
"name": "Accept",
"value": "application/jose+json"
},
{
"name": "x-tw-jose-method",
"value": "jwe"
},
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Send encrypted HTTP requests for testing purposes and receive responses encrypted with the original content encryption key. Encryption is mandatory for this endpoint — any message that is not in JSON Web Encryption (JWE) format will be rejected.\n"
},
{
"info": {
"name": "Playground JWS+JWE",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v1/auth/jose/playground/jwsjwe",
"headers": [
{
"name": "Accept",
"value": "application/jose+json"
},
{
"name": "x-tw-jose-method",
"value": "jws+jwe"
},
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Send test signed and encrypted HTTP requests and receive signed and encrypted responses. Both signing and encryption are mandatory for this endpoint. The request must be a JSON Web Signature (JWS) wrapped in JSON Web Encryption (JWE) — any message that does not follow this format will be rejected.\n\nThe flow combines both JWS and JWE:\n1. **Request**: Sign payload (JWS) → Encrypt signed JWT (JWE) → Send to Wise\n2. **Response**: Receive encrypted response → Decrypt (JWE) → Verify signature (JWS)\n\n{"
}
]
},
{
"info": {
"name": "kyc-review",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get all KYC Reviews for a profile",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v1/profiles/:profileId/kyc-reviews",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "The profile ID."
},
{
"name": "pageNumber",
"value": "",
"type": "query",
"description": "Page number. Default value is `1`."
},
{
"name": "pageSize",
"value": "",
"type": "query",
"description": "Desired number of items per page. Max `100`, default `100`."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieves a list of all active KYC Reviews for a given profile.\n"
},
{
"info": {
"name": "Create a KYC Review",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v1/profiles/:profileId/kyc-reviews",
"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": "Creates a KYC Review for a specific customer action.\n"
},
{
"info": {
"name": "Get KYC Review by ID (V1)",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v1/profiles/:profileId/kyc-reviews/:kycReviewId",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "The profile ID."
},
{
"name": "kycReviewId",
"value": "",
"type": "path",
"description": "The KYC Review ID."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "{% admonition type=\"warning\" %}\nThis endpoint is deprecated. Use [Get KYC Review by ID](kycreviewget) (V2) instead.\n{% /admonition %}\n\nRetrieves a single KYC Review by ID for a profile.\n"
},
{
"info": {
"name": "Update KYC Review to get a Hosted KYC link",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.wise.com/v1/profiles/:profileId/kyc-reviews/:kycReviewId",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "The profile ID."
},
{
"name": "kycReviewId",
"value": "",
"type": "path",
"description": "The KYC Review ID."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Updates the KYC Review with a redirect URL.\n\nReturns the KYC Review object with a `link` field containing a URL where the end customer needs to be directed in order to complete the Hosted KYC flow.\n\nOnce the Hosted KYC flow is completed by the end customer, they will be redirected to the `redirectUrl` provided in this API call. During the redirection, the `redirectUrl` will be appended with query parameters: `status=success`, `status=failed`, or `status=closed`.\n"
},
{
"info": {
"name": "Get KYC Review by ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v2/profiles/:profileId/kyc-reviews/:kycReviewId",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "The profile ID."
},
{
"name": "kycReviewId",
"value": "",
"type": "path",
"description": "The KYC Review ID."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieves a single KYC Review by ID for a profile.\n"
},
{
"info": {
"name": "Submit a KYC Requirement",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v2/profiles/:profileId/kyc-requirements/:requirementKey",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "The profile ID."
},
{
"name": "requirementKey",
"value": "",
"type": "path",
"description": "The KYC requirement type to submit.\n\nSee the [KYC requirement types](/guides/product/kyc/wise-kyc/kyc-requirement-types) guide for details on each type.\n"
}
],
"body": {
"type": "multipart-form",
"data": [
{
"name": "submissionData",
"type": "text",
"value": ""
},
{
"name": "files",
"type": "text",
"value": ""
}
]
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Submit a KYC requirement for a KYC Review.\n\n- A KYC requirement can only be submitted if the KYC Review status is `WAITING_CUSTOMER_INPUT` or `PASSED_WITH_REQUIREMENTS`.\n- A KYC requirement should only be submitted if its `state` is `NOT_PROVIDED` and `apiCollectionSupported` is `true`.\n\nSee the [KYC requirement types](/guides/product/kyc/wise-kyc/kyc-requirement-types) guide for the full list of supported requirement types, submission data structures, and accepted values.\n"
}
]
},
{
"info": {
"name": "multi-currency-account",
"type": "folder"
},
"items": [
{
"info": {
"name": "Retrieve available currencies",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v2/borderless-accounts-configuration/profiles/:profileId/available-currencies",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "Profile ID."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Lists all currencies that are available for balance accounts. This includes those that can have funds added from external accounts, as well as those that a balance can be held in.\n"
},
{
"info": {
"name": "Retrieve payin currencies",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v2/borderless-accounts-configuration/profiles/:profileId/payin-currencies",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "Profile ID."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Lists all currencies available for balance accounts that also support bank account details. You can use this list to create a balance account for the currency included and then subsequently create bank account details.\n"
},
{
"info": {
"name": "Retrieve multi currency account for a profile",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v4/profiles/:profileId/multi-currency-account",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "Profile ID."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns the multi-currency account details for the specified profile. If the user does not yet have a multi-currency account, a `404 Not Found` will be returned.\n"
},
{
"info": {
"name": "Retrieve multi currency account eligibility",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v4/multi-currency-account/eligibility",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "query",
"description": "Profile ID to check eligibility for."
},
{
"name": "country",
"value": "FR",
"type": "query",
"description": "2-letter ISO 3166 country code to check eligibility for."
},
{
"name": "state",
"value": "CA",
"type": "query",
"description": "2-letter state/province code. Required when `country` is `US`."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Checks eligibility for a multi-currency account for either a specific profile or for a location. Customers in some countries and states/provinces may not be eligible for a multi currency account.\n\nTo check a profile, pass the `profileId` as a query parameter.\n\nTo check a specific location, pass the `country` using 2-letter ISO 3166 codes. If the country is `US`, a valid 2-letter `state` parameter must also be passed.\n\n- Example (France): `/v4/multi-currency-account/eligibility?country=FR`\n- Exam"
}
]
},
{
"info": {
"name": "oauth-token",
"type": "folder"
},
"items": [
{
"info": {
"name": "Create an OAuth token",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/oauth/token",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"body": {
"type": "form-urlencoded",
"data": []
},
"auth": {
"type": "basic",
"username": "{{username}}",
"password": "{{password}}"
}
},
"docs": "Exchange credentials or authorisation grants for an OAuth 2.0 access token.\n\nThe `grant_type` field determines which parameters are required and which response fields are returned.\n\nSee [managing token expiration](/api-reference/oauth-token#managing-token-expiration) for guidance on refreshing tokens before they expire.\n"
}
]
},
{
"info": {
"name": "sca-ott",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get status of a one time token",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v1/one-time-token/status",
"headers": [
{
"name": "One-Time-Token",
"value": ""
},
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve necessary information to clear a OTT.\n"
},
{
"info": {
"name": "Get OTT status (v1)",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v1/identity/one-time-token/status",
"headers": [
{
"name": "One-Time-Token",
"value": ""
},
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "{% admonition type=\"warning\" %}\nThis endpoint is deprecated. Use the [new endpoint](/api-reference/sca-ott/ottstatusget) to get status of a one time token instead.\n{% /admonition %}\n\nRetrieve necessary information to clear a OTT.\n"
}
]
},
{
"info": {
"name": "sca-pin",
"type": "folder"
},
"items": [
{
"info": {
"name": "Verify PIN",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v1/one-time-token/pin/verify",
"headers": [
{
"name": "One-Time-Token",
"value": ""
},
{
"name": "Accept",
"value": "application/jose+json"
},
{
"name": "X-TW-JOSE-Method",
"value": "jwe"
},
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "[{% img src=\"https://img.shields.io/badge/jose-direct_encryption-blue\" /%}](/guides/developer/auth-and-security/jose-jwe){% .d-inline-block %}\n\nTo clear a **PIN** challenge listed in a OTT.\n\nNotes:\n1. User is required to [create pin](/api-reference/user-security/usersecuritypincreate) before the verification can be successful.\n2. Rate limit may be applied if there are 5 continuous unsuccessful attempts and OTT creation will be blocked for 15 minutes.\n"
},
{
"info": {
"name": "Create a PIN",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v2/profiles/:profileId/pin",
"headers": [
{
"name": "Accept",
"value": ""
},
{
"name": "Accept-Encoding",
"value": ""
},
{
"name": "Content-Encoding",
"value": ""
},
{
"name": "X-tw-jose-method",
"value": ""
},
{
"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": "Creates a new PIN factor used to resolve a SCA knowledge challenge type.\n\nThe request and response are encrypted using the JOSE framework. Please refer to the [SCA over API guide](/guides/developer/auth-and-security/sca-over-api) to understand how encryption and decryption work.\n"
},
{
"info": {
"name": "Delete a PIN",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.wise.com/v2/profiles/:profileId/pin",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "The profile ID."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Deletes a PIN associated to a profile.\n\nTo update a PIN for a profile, use this endpoint followed by [Create a PIN](/api-reference/sca-pin/scapincreate).\n\n{% admonition type=\"warning\" %}\nThis operation is irreversible.\n{% /admonition %}\n"
},
{
"info": {
"name": "Verify a PIN",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v2/profiles/:profileId/pin/verify",
"headers": [
{
"name": "One-Time-Token",
"value": ""
},
{
"name": "Accept",
"value": ""
},
{
"name": "Accept-Encoding",
"value": ""
},
{
"name": "Content-Encoding",
"value": ""
},
{
"name": "X-tw-jose-method",
"value": ""
},
{
"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": "Verifies a PIN challenge when calling a SCA-secured endpoint. Make sure to [create a PIN](/api-reference/sca-pin/scapincreate) before using this endpoint.\n\nThe request and response are encrypted using the JOSE framework. Please refer to the [SCA over API guide](/guides/developer/auth-and-security/sca-over-api) to understand how encryption and decryption work.\n"
}
]
},
{
"info": {
"name": "sca-device-fingerprints",
"type": "folder"
},
"items": [
{
"info": {
"name": "Verify Device Fingerprint",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v1/one-time-token/partner-device-fingerprint/verify",
"headers": [
{
"name": "One-Time-Token",
"value": ""
},
{
"name": "Accept",
"value": "application/jose+json"
},
{
"name": "X-TW-JOSE-Method",
"value": "jwe"
},
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "[{% img src=\"https://img.shields.io/badge/jose-direct_encryption-blue\" /%}](/guides/developer/auth-and-security/jose-jwe){% .d-inline-block %}\n\nTo clear a **Device Fingerprint** challenge listed in an OTT.\n\nNotes:\n1. User is required to [create a device fingerprint](/api-reference/user-security/usersecuritydevicefingerprintcreate) before the verification can be successful.\n2. Rate limit may be applied if there are 5 continuous unsuccessful attempts and OTT creation will be blocked for 15 minutes"
},
{
"info": {
"name": "Create a device fingerprint",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v2/profiles/:profileId/device-fingerprints",
"headers": [
{
"name": "Accept",
"value": ""
},
{
"name": "Accept-Encoding",
"value": ""
},
{
"name": "Content-Encoding",
"value": ""
},
{
"name": "X-tw-jose-method",
"value": ""
},
{
"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": "Creates a new device fingerprint factor used to resolve a SCA possession challenge type.\n\nThe request and response are encrypted using the JOSE framework. Please refer to the [SCA over API guide](/guides/developer/auth-and-security/sca-over-api) to understand how encryption and decryption work.\n"
},
{
"info": {
"name": "Verify a device fingerprint",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v2/profiles/:profileId/device-fingerprints/verify",
"headers": [
{
"name": "One-Time-Token",
"value": ""
},
{
"name": "Accept",
"value": ""
},
{
"name": "Accept-Encoding",
"value": ""
},
{
"name": "Content-Encoding",
"value": ""
},
{
"name": "X-tw-jose-method",
"value": ""
},
{
"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": "Verifies a device fingerprint challenge when calling a SCA-secured endpoint. Make sure to [create a device fingerprint](/api-reference/sca-device-fingerprints/scadevicefingerprintcreate) before using this endpoint.\n\nThe request and response are encrypted using the JOSE framework. Please refer to the [SCA over API guide](/guides/developer/auth-and-security/sca-over-api) to understand how encryption and decryption work.\n"
},
{
"info": {
"name": "Delete a device fingerprint",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.wise.com/v2/profiles/:profileId/device-fingerprints/:deviceFingerprintId",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "The profile ID."
},
{
"name": "deviceFingerprintId",
"value": "",
"type": "path",
"description": "The device fingerprint ID."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Deletes a device fingerprint associated to a profile. Include the `deviceFingerprintId` in the URL to delete a device fingerprint. This ID is provided in the response when the device fingerprint is created.\n\n{% admonition type=\"warning\" %}\nThis operation is irreversible.\n{% /admonition %}\n"
}
]
},
{
"info": {
"name": "sca-facemaps",
"type": "folder"
},
"items": [
{
"info": {
"name": "Verify FaceMap",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v1/one-time-token/facemap/verify",
"headers": [
{
"name": "One-Time-Token",
"value": ""
},
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "To clear a **FACE_MAP** challenge listed in a OTT.\n\nNotes:\n1. User is required to [enrol facemap](/api-reference/user-security/usersecurityfacemapenrol) before the verification can be successful.\n2. Rate limit may be applied if there are 5 continuous unsuccessful attempts and OTT creation will be blocked for 15 minutes.\n"
},
{
"info": {
"name": "Create a facemap",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v2/profiles/:profileId/facemaps",
"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": "Creates a new facemap factor used to resolve a SCA inherence challenge type.\n\nA facemap should be exported from your FaceTec server using the SDK's [export API](https://dev.facetec.com/api-guide#export-3d-facemap). Please use Wise's FaceTec [public key](/api-reference/facetec/facetecpublickeyget) to encrypt the facemap during the export process.\n"
},
{
"info": {
"name": "Delete a facemap",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.wise.com/v2/profiles/:profileId/facemaps",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "The profile ID."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Deletes a facemap associated to a profile.\n\nTo update a facemap for a profile, use this endpoint followed by [Create a facemap](/api-reference/sca-facemaps/scafacemapcreate).\n\n{% admonition type=\"warning\" %}\nThis operation is irreversible.\n{% /admonition %}\n"
},
{
"info": {
"name": "Verify a facemap",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v2/profiles/:profileId/facemaps/verify",
"headers": [
{
"name": "One-Time-Token",
"value": ""
},
{
"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": "Verifies a facemap challenge when calling a SCA-secured endpoint. Make sure to [create a facemap](/api-reference/sca-facemaps/scafacemapcreate) before using this endpoint.\n\nA facemap should be exported from your FaceTec server using the SDK's [export API](https://dev.facetec.com/api-guide#export-3d-facemap). Please use Wise's FaceTec [public key](/api-reference/facetec/facetecpublickeyget) to encrypt a facemap during the export process.\n"
}
]
},
{
"info": {
"name": "user-security",
"type": "folder"
},
"items": [
{
"info": {
"name": "List Phone Numbers",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v1/application/users/:userId/phone-numbers",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "userId",
"value": "",
"type": "path",
"description": "User ID."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List verified phone numbers for a user.\n\n{% admonition type=\"warning\" %}\nThis endpoint is restricted and requires both a client credentials token and additional access to use. Please speak with your implementation manager if you would like to use this API.\n{% /admonition %}\n"
},
{
"info": {
"name": "Update Phone Number",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.wise.com/v1/application/users/:userId/phone-numbers/:phoneNumberId",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "userId",
"value": "",
"type": "path",
"description": "User ID."
},
{
"name": "phoneNumberId",
"value": "",
"type": "path",
"description": "ID of a phone number."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update a verified phone number for a user.\n\n{% admonition type=\"warning\" %}\nThis endpoint is restricted and requires both a client credentials token and additional access to use. Please speak with your implementation manager if you would like to use this API.\n{% /admonition %}\n"
},
{
"info": {
"name": "Create PIN",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v1/user/pin",
"headers": [
{
"name": "Accept",
"value": ""
},
{
"name": "Accept-Encoding",
"value": ""
},
{
"name": "Content-Encoding",
"value": ""
},
{
"name": "X-tw-jose-method",
"value": ""
},
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create PIN for a user as a form of authentication.\n\nCan be used to [verify pin](/api-reference/sca-pin/ottpinverify) when accessing a strongly protected endpoint via [One Time Token Framework](/api-reference/sca-ott).\n\nThe request and response are encrypted using the JOSE framework. Please refer to the [JOSE JWE guide](/guides/developer/auth-and-security/jose-jwe) to understand how encryption and decryption work.\n"
},
{
"info": {
"name": "Delete PIN",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.wise.com/v1/users/:userId/pin",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "userId",
"value": "",
"type": "path",
"description": "User ID."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Remove the PIN from the user's account.\n\n{% admonition type=\"warning\" %}\nThis endpoint is restricted and requires both a client credentials token and additional access to use. Please speak with your implementation manager if you would like to use this API.\n{% /admonition %}\n"
},
{
"info": {
"name": "Enrol FaceMap",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v1/user/facemap/enrol",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Facial biometric enrolment for Strong Customer Authentication (SCA).\n\nCan be used to [verify facemap](/api-reference/sca-facemaps/ottfacemapverify) when accessing a strongly protected endpoint via [One Time Token Framework](/api-reference/sca-ott).\n"
},
{
"info": {
"name": "Delete FaceMap",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.wise.com/v1/users/:userId/facemap/enrol",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "userId",
"value": "",
"type": "path",
"description": "User ID."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Remove the FaceMap from the user's account.\n\n{% admonition type=\"warning\" %}\nThis endpoint is restricted and requires both a client credentials token and additional access to use. Please speak with your implementation manager if you would like to use this API.\n{% /admonition %}\n"
},
{
"info": {
"name": "Create Device Fingerprint",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v1/user/partner-device-fingerprints",
"headers": [
{
"name": "Accept",
"value": ""
},
{
"name": "Accept-Encoding",
"value": ""
},
{
"name": "Content-Encoding",
"value": ""
},
{
"name": "X-tw-jose-method",
"value": ""
},
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "A device fingerprint represents a string that identifies a unique device.\n\nThis endpoint is used to register the fingerprint of the device as one of the allowed devices used during an One Time Token (OTT) challenge.\n\nThis can be used to [verify device fingerprint](/api-reference/sca-device-fingerprints/ottdevicefingerprintverify) when clearing a [OTT](/api-reference/sca-ott).\n\nThe request and response are encrypted using the JOSE framework. Please refer to the [JOSE JWE guide](/guides/developer/"
},
{
"info": {
"name": "List Device Fingerprints",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v1/users/:userId/partner-device-fingerprints",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "userId",
"value": "",
"type": "path",
"description": "User ID."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns a list of device fingerprints created for this user.\n\n{% admonition type=\"warning\" %}\nThis endpoint is restricted and requires both a client credentials token and additional access to use. Please speak with your implementation manager if you would like to use this API.\n{% /admonition %}\n"
},
{
"info": {
"name": "Delete Device Fingerprint",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.wise.com/v1/users/:userId/partner-device-fingerprints/:deviceFingerprintId",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "userId",
"value": "",
"type": "path",
"description": "User ID."
},
{
"name": "deviceFingerprintId",
"value": "",
"type": "path",
"description": "Device fingerprint ID."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Remove a specific device fingerprint from the allowed devices of a user.\n\n{% admonition type=\"warning\" %}\nThis endpoint is restricted and requires both a client credentials token and additional access to use. Please speak with your implementation manager if you would like to use this API.\n{% /admonition %}\n"
}
]
},
{
"info": {
"name": "sca-otp",
"type": "folder"
},
"items": [
{
"info": {
"name": "Create Phone Number",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v1/application/users/:userId/phone-numbers",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "userId",
"value": "",
"type": "path",
"description": "User ID."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create a verified phone number for a user.\n\n{% admonition type=\"warning\" %}\nThis endpoint is restricted and requires both a client credentials token and additional access to use. Please speak with your implementation manager if you would like to use this API.\n{% /admonition %}\n"
},
{
"info": {
"name": "Trigger SMS Challenge",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v1/one-time-token/sms/trigger",
"headers": [
{
"name": "One-Time-Token",
"value": ""
},
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "To trigger a SMS challenge by sending SMS to user verified [phone number](/api-reference/user-security/usersecurityphonenumberlist) containing a 6 digit one time password (**OTP**).\n\nThis **OTP** code can be used to clear a SMS challenge by using the [Verify SMS endpoint](/api-reference/sca-otp/ottsmsverify).\n"
},
{
"info": {
"name": "Verify SMS Challenge",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v1/one-time-token/sms/verify",
"headers": [
{
"name": "One-Time-Token",
"value": ""
},
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "To clear a **SMS** challenge listed in a OTT.\n\nNotes:\n1. User is required to have a verified phone number. See [create phone number](/api-reference/sca-otp/usersecurityphonenumbercreate) for more information.\n2. [Trigger SMS Challenge](/api-reference/sca-otp/ottsmstrigger) is required to be called first.\n3. Since we won't be sending real SMS on sandbox, the **OTP Code** will always be **111111**.\n"
},
{
"info": {
"name": "Trigger WhatsApp Challenge",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v1/one-time-token/whatsapp/trigger",
"headers": [
{
"name": "One-Time-Token",
"value": ""
},
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "To trigger a WhatsApp challenge by sending WhatsApp message to user verified [phone number](/api-reference/user-security/usersecurityphonenumberlist) containing a 6 digit one time password (**OTP**).\n\nThis **OTP** code can be used to clear a WHATSAPP challenge by using the [Verify WhatsApp endpoint](/api-reference/sca-otp/ottwhatsappverify).\n"
},
{
"info": {
"name": "Verify WhatsApp Challenge",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v1/one-time-token/whatsapp/verify",
"headers": [
{
"name": "One-Time-Token",
"value": ""
},
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "To clear a **WHATSAPP** challenge listed in a OTT.\n\nNotes:\n1. User is required to have a verified phone number. See [create phone number](/api-reference/sca-otp/usersecurityphonenumbercreate) for more information.\n2. [Trigger WhatsApp Challenge](/api-reference/sca-otp/ottwhatsapptrigger) is required to be called first.\n3. Since we won't be sending real WhatsApp message on sandbox, the **OTP Code** will always be **111111**.\n"
},
{
"info": {
"name": "Trigger Voice Challenge",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v1/one-time-token/voice/trigger",
"headers": [
{
"name": "One-Time-Token",
"value": ""
},
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "To trigger a Voice challenge by sending voice message to user verified [phone number](/api-reference/user-security/usersecurityphonenumberlist) containing a 6 digit one time password (**OTP**).\n\nThis **OTP** code can be used to clear a VOICE challenge by using the [Verify Voice endpoint](/api-reference/sca-otp/ottvoiceverify).\n"
},
{
"info": {
"name": "Verify Voice Challenge",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v1/one-time-token/voice/verify",
"headers": [
{
"name": "One-Time-Token",
"value": ""
},
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "To clear a **VOICE** challenge listed in a OTT.\n\nNotes:\n1. User is required to have a verified phone number. See [create phone number](/api-reference/sca-otp/usersecurityphonenumbercreate) for more information.\n2. [Trigger Voice Challenge](/api-reference/sca-otp/ottvoicetrigger) is required to be called first.\n3. Since we won't be sending real voice message on sandbox, the **OTP Code** will always be **111111**.\n"
},
{
"info": {
"name": "Delete Phone Number",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.wise.com/v1/application/users/:userId/phone-numbers/:phoneNumberId",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "userId",
"value": "",
"type": "path",
"description": "User ID."
},
{
"name": "phoneNumberId",
"value": "",
"type": "path",
"description": "ID of a phone number."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete a verified phone number for a user.\n\n{% admonition type=\"warning\" %}\nThis endpoint is restricted and requires both a client credentials token and additional access to use. Please speak with your implementation manager if you would like to use this API.\n{% /admonition %}\n"
}
]
},
{
"info": {
"name": "case",
"type": "folder"
},
"items": [
{
"info": {
"name": "Create a partner case",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v1/cases",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Cases are used to collect or transmit additional information between Partners and Wise. Use this endpoint to create a new case.\n\n{% admonition type=\"warning\" %}\nPlease do not include PII in the `subject` of a case. Any specific details regarding the case that need to be communicated should be included in the `description`.\n{% /admonition %}\n"
},
{
"info": {
"name": "Retrieve a partner case by ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v1/cases/:caseId",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "caseId",
"value": "",
"type": "path",
"description": "Partner Case ID."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "This endpoint returns a partner case based on the specified case ID.\n"
},
{
"info": {
"name": "Retrieve partner case comments",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v1/cases/:caseId/comments",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "caseId",
"value": "",
"type": "path",
"description": "Partner Case ID."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "This endpoint returns a comments list object, which is an array of comments that have been associated with the case. Comments are ordered newest to oldest and are not paginated (all comments returned at once).\n"
},
{
"info": {
"name": "Add a partner case comment",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.wise.com/v1/cases/:caseId/comments",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "caseId",
"value": "",
"type": "path",
"description": "Partner Case ID."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "This endpoint allows for a comment to be placed on a partner case.\n"
}
]
},
{
"info": {
"name": "payins",
"type": "folder"
},
"items": [
{
"info": {
"name": "Create PayNow payment details",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v1/profiles/:profileId/payin-sessions/:payinSessionId/paynow",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "Profile ID of the profile that created the transfer."
},
{
"name": "payinSessionId",
"value": "",
"type": "path",
"description": "Payin Session ID retrieved from Transfer object."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Creates the encoded QR code and details for the payin session so the user can fund a transfer or balance top-up via a PayNow transaction.\nThis operation supports the SGD currency only.\n\n{% admonition type=\"warning\" %}\nThis operation is not available for sandbox testing.\n{% /admonition %}\n"
}
]
},
{
"info": {
"name": "payin-deposit-detail",
"type": "folder"
},
"items": [
{
"info": {
"name": "Retrieve bank transfer deposit details",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v1/profiles/:profileId/transfers/:transferId/deposit-details/bank-transfer",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "Profile ID."
},
{
"name": "transferId",
"value": "",
"type": "path",
"description": "Transfer ID."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve the bank details for the account that the customer should send funds to when paying for a Wise transfer via a bank transfer.\n\n`profileId` in the request URL refers to the profile that created the transfer. It can be either the personal profile ID, or the business profile ID.\n\nThe `payinBankAccount` field allows the bank details to be displayed dynamically in a user interface, by displaying the label and value fields.\n\nCurrently, this API supports the following currencies: AUD, BGN, BRL,"
}
]
},
{
"info": {
"name": "profile",
"type": "folder"
},
"items": [
{
"info": {
"name": "Create a profile (V1)",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v1/profiles",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "{% admonition type=\"warning\" %}\nThis endpoint is deprecated. Please see the [Create Personal Profile](/api-reference/profile/profilepersonalcreate) and [Create Business Profile](/api-reference/profile/profilebusinesscreate) v2 endpoints.\n{% /admonition %}\n\nCreate personal or business user profile. Set `type` to `\"personal\"` or `\"business\"`.\n\nOne person cannot have multiple active duplicate user profiles, creating multiple profiles with the same details will fail. When this happens, you should sh"
},
{
"info": {
"name": "Update a profile (V1)",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.wise.com/v1/profiles",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "{% admonition type=\"warning\" %}\nThis endpoint is deprecated. Please see the [Update Personal Profile](/api-reference/profile/profilepersonalupdate) and [Update Business Profile](/api-reference/profile/profilebusinessupdate) v2 endpoints.\n{% /admonition %}\n\nUpdate user profile information. Request and response is same as described in the create profile endpoint, with the addition of the `id` field.\n\n{% admonition type=\"info\" %}\nIf user profile has been verified then there are restrictions on what"
},
{
"info": {
"name": "List profiles for a user account",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v2/profiles",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List of all profiles belonging to user.\n"
},
{
"info": {
"name": "Create a personal profile",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v2/profiles/personal-profile",
"headers": [
{
"name": "X-idempotence-uuid",
"value": ""
},
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create a personal profile for the authenticated user. A personal profile represents an individual and is required before creating transfers or business profiles.\n\n{% admonition type=\"info\" %}\nUse the `X-idempotence-uuid` header to safely retry requests. If omitted and a profile already exists, the API returns `409 Conflict`. You can then retrieve existing profiles via [List profiles](/api-reference/profile/profilelist).\n{% /admonition %}\n\nField notes {% .title-4 .m-t-3 %}\n\n- **First and last nam"
},
{
"info": {
"name": "Create a business profile",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v2/profiles/business-profile",
"headers": [
{
"name": "X-idempotence-uuid",
"value": ""
},
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "It is required that you first create a personal profile with details of the authorized representative of the business. It is currently not possible to create a business profile without first creating a personal profile.\n\n{% admonition type=\"info\" %}\nThis request accepts an optional field in the header, `X-idempotence-uuid`. This should be unique for each Profile you create. In the event that the request fails, you should use the same value again when retrying. If the `X-idempotence-uuid` header "
},
{
"info": {
"name": "Create a business profile (V3)",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v3/profiles/business-profile",
"headers": [
{
"name": "X-idempotence-uuid",
"value": ""
},
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create a business profile and its authorized representative in a single request.\n\n{% admonition type=\"info\" %}\nThis request accepts an optional field in the header, `X-idempotence-uuid`. This should be unique for each Profile you create. In the event that the request fails, you should use the same value again when retrying. If the `X-idempotence-uuid` header is not provided and a Profile already exists, then you will receive a response with an HTTP status code `409`.\n{% /admonition %}\n\nSee [Busi"
},
{
"info": {
"name": "Retrieve a profile by ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v2/profiles/:profileId",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "Profile ID."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get profile info by ID.\n"
},
{
"info": {
"name": "Update a personal profile",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.wise.com/v2/profiles/:profileId/personal-profile",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "Personal profile ID."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update user profile information for a personal profile.\n\n{% admonition type=\"warning\" %}\nIf user profile has been verified then there are restrictions on what information is allowed to change. Where permitted, use the update window functionality by [opening the update window](/api-reference/profile/profileupdatewindowopen), submitting the updated information using this endpoint, and finally [closing the update window](/api-reference/profile/profileupdatewindowclose).\n{% /admonition %}\n"
},
{
"info": {
"name": "Update a business profile",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.wise.com/v2/profiles/:profileId/business-profile",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "Business profile ID."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update user profile information for a business profile.\n\n{% admonition type=\"warning\" %}\nIf user profile has been verified then there are restrictions on what information is allowed to change.\n{% /admonition %}\n\nWhere permitted, use the update window functionality by [opening the update window](/api-reference/profile/profileupdatewindowopen), submitting the updated information using this endpoint, and finally [closing the update window](/api-reference/profile/profileupdatewindowclose).\n\nSee [Bus"
},
{
"info": {
"name": "Retrieve business representative",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v3/profiles/:profileId/business-profile/business-representative",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "Business profile ID."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get Business Representative info by Business Profile ID.\n"
},
{
"info": {
"name": "Update business representative",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.wise.com/v3/profiles/:profileId/business-profile/business-representative",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "Business profile ID."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update or transfer the Business Representative for the specified Business Profile.\n\nSet `updateContext` to `UPDATE_DETAILS` to update the existing Business Representative's details, or `TRANSFER_OF_AUTHORISATION` to transfer authority of the Business Profile to a new Business Representative.\n\n{% admonition type=\"info\" %}\nIf the Business Representative has been verified then there are restrictions on what information is allowed to change.\n{% /admonition %}\n\n{% admonition type=\"info\" %}\nIf this Bu"
},
{
"info": {
"name": "Create an identification document",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v1/profiles/:profileId/verification-documents",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "Profile ID."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Add an identification document to a personal profile. Not applicable to business profiles.\n\nFor SSN submissions, only `type` and `uniqueIdentifier` (9 digits, no letters or symbols) are required.\n"
},
{
"info": {
"name": "Update an identification document",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.wise.com/v1/profiles/:profileId/verification-documents",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "Profile ID."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update an existing identification document on a personal profile. Not\napplicable to business profiles.\n\nThis endpoint performs a full replacement of the document details. Any\nfields not provided in the request body will be set to null on the stored\ndocument. Partners must provide all fields they wish to retain. \n\nOnly partners with a KYC partner onboarding model\nare permitted to use this endpoint. Non-KYC partners will receive a 400 error.\n"
},
{
"info": {
"name": "List business directors",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v1/profiles/:profileId/directors",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "Business profile ID."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns the list of director objects associated with the business profile.\n"
},
{
"info": {
"name": "Create business directors",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v1/profiles/:profileId/directors",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "Business profile ID."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Adds new directors to the business profile.\n\nReturns the list of all directors associated with the business profile.\n"
},
{
"info": {
"name": "Update business directors",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.wise.com/v1/profiles/:profileId/directors",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "Business profile ID."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Overrides directors in the business profile.\n\nReturns the list of all directors associated with the business profile.\n"
},
{
"info": {
"name": "List business ultimate owners",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v1/profiles/:profileId/ubos",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "Business profile ID."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns the list of all ultimate beneficial owners associated with the business profile.\n"
},
{
"info": {
"name": "Create business ultimate owners",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v1/profiles/:profileId/ubos",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "Business profile ID."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Adds new ultimate beneficial owners to the business profile.\n\nReturns the list of all ultimate beneficial owners associated with the business profile.\n\nAll the shareholders that have at least 25% ownership should be submitted via this API.\n\nNote that in some cases, we do not require the `ownershipPercentage`. In these cases, `null` should be passed as the value.\n"
},
{
"info": {
"name": "Update business ultimate owners",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.wise.com/v1/profiles/:profileId/ubos",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "Business profile ID."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Overrides ultimate beneficial owners in the business profile.\n\nReturns the list of all ultimate beneficial owners associated with the business profile.\n"
},
{
"info": {
"name": "Open an update window",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v1/profiles/:profileId/update-window",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "Profile ID."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Opens the update window for updating the profile information: details, addresses, directors, owners, others.\n"
},
{
"info": {
"name": "Close an update window",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.wise.com/v1/profiles/:profileId/update-window",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "Profile ID."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Deletes the update window for updating the profile.\n"
},
{
"info": {
"name": "Retrieve profile extension requirements",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v1/profiles/:profileId/extension-requirements",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "Profile ID."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "{% admonition type=\"warning\" %}\nThis endpoint is deprecated. Please check the [Additional Verification](/api-reference/verification) endpoints for providing additional verification details for a profile.\n{% /admonition %}\n\nAfter having a profile created, in some situations we can need more specific information about it. In order to know which fields are required for a given profile, and to send the information over, we expose a few endpoints:\n\n- `GET /v1/profiles/{profileId}/extension-requiremen"
},
{
"info": {
"name": "Update profile extensions dynamically",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v1/profiles/:profileId/extension-requirements",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "Profile ID."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "{% admonition type=\"warning\" %}\nThis endpoint is deprecated. Please check the [Additional Verification](/api-reference/verification) endpoints for providing additional verification details for a profile.\n{% /admonition %}\n\nPost extension requirements to discover additional required fields based on selected values. See the [GET extension-requirements](/api-reference/profile/profileextensionrequirementsget) endpoint for full details on how to use these endpoints together.\n"
},
{
"info": {
"name": "Retrieve profile extensions",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v1/profiles/:profileId/extensions",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "Profile ID."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "{% admonition type=\"warning\" %}\nThis endpoint is deprecated. Please check the [Additional Verification](/api-reference/verification) endpoints for providing additional verification details for a profile.\n{% /admonition %}\n\nRetrieve the extra profile information previously submitted via extensions. See the [GET extension-requirements](/api-reference/profile/profileextensionrequirementsget) endpoint for full details on how to use these endpoints together.\n"
},
{
"info": {
"name": "Submit profile extensions",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v1/profiles/:profileId/extensions",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "Profile ID."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "{% admonition type=\"warning\" %}\nThis endpoint is deprecated. Please check the [Additional Verification](/api-reference/verification) endpoints for providing additional verification details for a profile.\n{% /admonition %}\n\nSubmit the extra profile information gathered from the extension requirements. See the [GET extension-requirements](/api-reference/profile/profileextensionrequirementsget) endpoint for full details on how to use these endpoints together.\n"
},
{
"info": {
"name": "Check profile verification status",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v3/profiles/:profileId/verification-status/bank-transfer",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "Profile ID."
},
{
"name": "source_currencies",
"value": "GBP,USD,EUR",
"type": "query",
"description": "Comma-separated list of ISO 4217 currency codes."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "You can check the verification status of a profile using this API. This is a profile-specific API resource which should be accessed using an access token acquired for the profile.\n\nWe do not expose any finer details of customer verification.\n"
}
]
},
{
"info": {
"name": "digital-wallet",
"type": "folder"
},
"items": [
{
"info": {
"name": "List payment tokens for a card",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v3/spend/profiles/:profileId/cards/:cardToken/payment-tokens",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "12345",
"type": "path",
"description": "The profile ID."
},
{
"name": "cardToken",
"value": "a3f90c98-1cd1-4488-9050-2e32c696f8fa",
"type": "path",
"description": "The card token."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "You have the option to obtain the payment tokens associated with a card, which can assist in determining if it's already linked to a specific wallet.\nNote that the payment token status associated with the card may not be accurate (for example, after a phone factory reset).\nTherefore, it's advisable to consistently check the wallet instance for the most up-to-date token status.\n"
},
{
"info": {
"name": "Manual provisioning payment token activation",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v3/spend/profiles/:profileId/cards/:cardToken/payment-tokens/:paymentTokenUniqueReference/activation",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "12345",
"type": "path",
"description": "The profile ID"
},
{
"name": "cardToken",
"value": "a3f90c98-1cd1-4488-9050-2e32c696f8fa",
"type": "path",
"description": "The card token"
},
{
"name": "paymentTokenUniqueReference",
"value": "DNITHE382607223583426199",
"type": "path",
"description": "The payment token unique reference issued by the scheme token service"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "This endpoint activates the payment token for a card that has been manually added to a wallet provider. Please read this [guide](/guides/product/issue-cards/card-digital-wallet.md) before implementing this API.\n{% admonition type=\"warning\" %}\nThis API is not available for sandbox testing.\n{% /admonition %}\n"
},
{
"info": {
"name": "Push provisioning for Google Pay",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/twcard-data/v1/push-provisioning/encrypted-payload/google-pay",
"headers": [
{
"name": "x-tw-twcard-card-token",
"value": "a3f90c98-1cd1-4488-9050-2e32c696f8fa"
},
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns encrypted cardholder information and other metadata needed for Google Pay push provisioning.\n\n{% admonition type=\"warning\" %}\nThis API is not available for sandbox testing.\n{% /admonition %}\n"
},
{
"info": {
"name": "Push Provisioning for Apple Pay",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/twcard-data/v1/push-provisioning/encrypted-payload/apple-pay",
"headers": [
{
"name": "x-tw-twcard-card-token",
"value": "a3f90c98-1cd1-4488-9050-2e32c696f8fa"
},
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns encrypted cardholder information and other metadata needed for Apple Pay push provisioning.\n\n{% admonition type=\"warning\" %}\nThis API is not available for sandbox testing.\n{% /admonition %}\n"
}
]
},
{
"info": {
"name": "quote",
"type": "folder"
},
"items": [
{
"info": {
"name": "Create a quote (unauthenticated)",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v3/quotes",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Use this endpoint to get example quotes for people to see the exchange rate and fees Wise offers before a user has created or linked an account. This can drive a version of the quote screen that shows the user what Wise offers before they sign up.\nNote that this endpoint does not require a token to create the resource, however, since it is just an example, the returned quote has no ID so can't be used later to create a transfer.\n\nIn order to get an accurate partner fee, we require a client crede"
},
{
"info": {
"name": "Create a quote (authenticated)",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v3/profiles/:profileId/quotes",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "101",
"type": "path",
"description": "Personal or business profile ID of the sender."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "{% admonition type=\"info\" %}\nYou must use a user access token to authenticate this call and supply the profile with which the quote should be associated. This ensures that quote can be used to create a transfer.\n{% /admonition %}\n\nIf you are funding the transfer from a Multi Currency Balance, you must set the `payIn` as `BALANCE` to get the correct pricing in the quote. Not doing so will default to `BANK_TRANSFER` and the fees will be inconsistent between quote and transfer.\n\n{% admonition type="
},
{
"info": {
"name": "Retrieve a quote by ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v3/profiles/:profileId/quotes/:quoteId",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "101",
"type": "path",
"description": "Personal or business profile ID."
},
{
"name": "quoteId",
"value": "11144c35-9fe8-4c32-b7fd-d05c2a7734bf",
"type": "path",
"description": "The quote ID (GUID format)."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get quote info by ID. If the quote has expired (not used to create a transfer within 30 minutes of quote creation), it will only be accessible for approximately 48 hours via this endpoint.\n"
},
{
"info": {
"name": "Update a quote",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.wise.com/v3/profiles/:profileId/quotes/:quoteId",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "101",
"type": "path",
"description": "Personal or business profile ID."
},
{
"name": "quoteId",
"value": "11144c35-9fe8-4c32-b7fd-d05c2a7734bf",
"type": "path",
"description": "The quote ID (GUID format)."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "You should update a quote using a `PATCH` call to add a recipient. This will update the saved quote's data based on who and where the money will be sent to.\n\nUpdating the quote with a recipient may cause the available payment options, prices and estimated delivery times to change from the original quoted amounts. This is due to the fact that sending some currencies to some destinations costs a different amount based on the payment networks we use, for example sending USD to a country outside the"
}
]
},
{
"info": {
"name": "rate",
"type": "folder"
},
"items": [
{
"info": {
"name": "Retrieve current rates",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v1/rates",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "source",
"value": "EUR",
"type": "query",
"description": "Source (send) currency code."
},
{
"name": "target",
"value": "USD",
"type": "query",
"description": "Target (receive) currency code."
},
{
"name": "time",
"value": "2019-02-13T14:53:01",
"type": "query",
"description": "Timestamp to get historic exchange rate.
Supports only Timestamp (combined date and time). Timezone offset is supported but optional.
Supported examples: `2019-03-13T14:53:01` or `2019-03-13T14:53:01+0100`.\n"
},
{
"name": "from",
"value": "2019-02-13T14:53:01",
"type": "query",
"description": "Period start date/time to get exchange rate history.
Supports Timestamp (combined date and time) or Date (date only).
Supported examples: `2019-03-13T14:53:01` or `2019-03-13`.\n"
},
{
"name": "to",
"value": "2019-03-13T14:53:01",
"type": "query",
"description": "Period end date/time to get exchange rate history.
Supports Timestamp (combined date and time) or Date (date only).
Timezone offset is supported but optional.
Supported examples: `2019-03-13T14:53:01+0100` or `2019-03-13+0100`.\n"
},
{
"name": "group",
"value": "day",
"type": "query",
"description": "Interval for history grouping."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "{% admonition type=\"warning\" %}\nThe `from`, `to`, and `group` parameters are not testable in our Sandbox environment at this time.\n{% /admonition %}\n\n`GET /v1/rates`
\nFetch latest exchange rates of all currencies.\n\n`GET /v1/rates?source=EUR&target=USD`
\nFetch latest exchange rate of one currency pair.\n\n`GET /v1/rates?source=EUR&target=USD&time=2019-02-13T14:53:01`
\nFetch exchange rate of specific historical timestamp.\n\n`GET /v1/rates?source=EUR&target=USD&from=2019-02-13T14:53:01&to=201"
}
]
},
{
"info": {
"name": "recipient",
"type": "folder"
},
"items": [
{
"info": {
"name": "List recipient accounts (v1)",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v1/accounts",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "query",
"description": "Filter by personal or business profile, returns only those owned by this profile."
},
{
"name": "currency",
"value": "",
"type": "query",
"description": "Filter responses by currency."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "{% admonition type=\"warning\" %}\nThis is a deprecated v1 endpoint. For new integrations please use the [v2 list endpoint](/api-reference/recipient/recipientlist).\n{% /admonition %}\n\nFetch a list of the user's recipient accounts. Use the `currency` and `profile` parameters to filter by currency and/or the owning user profile ID. This endpoint does not support pagination, so please filter by currency to ensure a reasonable response time.\n\nBoth query parameters are optional.\n"
},
{
"info": {
"name": "Create a recipient account",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v1/accounts",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "refund",
"value": "",
"type": "query",
"description": "When true, creates a refund recipient account."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Creates a recipient account. A **recipient** is a person or institution who is the ultimate beneficiary of your payment.\n\nRecipient data includes three data blocks:\n- General data - the personal details of an individual and basic information about a business.\n- Bank details - account numbers, routing numbers, and other region-specific bank details.\n- Address details - country and street address of an individual or business.\n\nNotes:\n- Date of Birth is optional; consult the account-requirements AP"
},
{
"info": {
"name": "List recipient accounts",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v2/accounts",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "creatorId",
"value": "",
"type": "query",
"description": "Creator of the account."
},
{
"name": "profileId",
"value": "",
"type": "query",
"description": "Filter by personal or business profile. Defaults to the personal profile."
},
{
"name": "profile",
"value": "",
"type": "query",
"description": "Alias for `profileId`."
},
{
"name": "currency",
"value": "",
"type": "query",
"description": "Filter responses by currency. Comma separated values supported (e.g. `USD,GBP`)."
},
{
"name": "active",
"value": "",
"type": "query",
"description": "Filter by whether this profile is active. Defaults to `true`."
},
{
"name": "type",
"value": "",
"type": "query",
"description": "Filter responses by account type. Comma separated values supported (e.g. `iban,swift_code`)."
},
{
"name": "ownedByCustomer",
"value": "",
"type": "query",
"description": "Filter to get accounts owned by the customer or not. Leave out to get all accounts."
},
{
"name": "size",
"value": "",
"type": "query",
"description": "Page size of the response. Defaults to a maximum of 20."
},
{
"name": "seekPosition",
"value": "",
"type": "query",
"description": "Account ID to start the page of responses from. `null` if no more pages."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "Sorting strategy for the response. Comma separated options - firstly either `id` or `currency`, followed by `asc` or `desc` for direction."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Fetch a list of the user's recipient accounts. Use the `profileId` parameter to filter by the profile who created the accounts, you should do this based on the personal or business profile ID you have linked to, based on your use case. Other filters are listed below for your convenience, for example `currency` is a useful filter to use when presenting the user a list of recipients to choose from in the case they have already submitted the target currency in your flow.\n\n#### Pagination\nPagination"
},
{
"info": {
"name": "Get account by ID (v1)",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v1/accounts/:accountId",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "Recipient account ID."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "{% admonition type=\"warning\" %}\nThis is a deprecated v1 endpoint. For new integrations please use the [v2 get endpoint](/api-reference/recipient/recipientget).\n{% /admonition %}\n\nGet recipient account info by ID.\n"
},
{
"info": {
"name": "Get account by ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v2/accounts/:accountId",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "Recipient account ID."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get recipient account info by ID.\n\n{% admonition type=\"info\" %}\nV1 and v2 versions are cross compatible, but the v2 endpoint provides additional features.\n{% /admonition %}\n"
},
{
"info": {
"name": "Deactivate a recipient account",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.wise.com/v2/accounts/:accountId",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "Recipient account ID."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Deletes a recipient by changing its status to inactive (`\"active\": false`).\n\nRequesting to delete a recipient that is already inactive returns HTTP 403 (Forbidden).\n\n{% admonition type=\"info\" %}\nOnly active recipients can be deleted and a recipient cannot be reactivated, however you can create a new recipient with the same details instead if necessary.\n{% /admonition %}\n"
},
{
"info": {
"name": "Retrieve recipient account requirements dynamically",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v1/quotes/:quoteId/account-requirements",
"headers": [
{
"name": "Accept-Minor-Version",
"value": ""
},
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "quoteId",
"value": "",
"type": "path",
"description": "Quote ID (supports long or UUID based IDs)."
},
{
"name": "originatorLegalEntityType",
"value": "",
"type": "query",
"description": "Legal entity type override for the actual sender."
},
{
"name": "addressRequired",
"value": "",
"type": "query",
"description": "Set to true so address is always required."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "{% admonition type=\"info\" %}\nPlease note that to use v1.1 `Accept-Minor-Version: 1` request header must be set.\n{% /admonition %}\n\n`GET /v1/quotes/{quoteId}/account-requirements`
\n`POST /v1/quotes/{quoteId}/account-requirements`
\n`GET /v1/account-requirements?source=EUR&target=USD&sourceAmount=1000`\n\nYou can use the data returned by this API to build a dynamic user interface for recipient creation. The `GET` and `POST` account-requirements endpoints help you to figure out which fields are "
},
{
"info": {
"name": "Retrieve recipient account requirements dynamically (step-by-step)",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v1/quotes/:quoteId/account-requirements",
"headers": [
{
"name": "Accept-Minor-Version",
"value": ""
},
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "quoteId",
"value": "",
"type": "path",
"description": "Quote ID (supports long or UUID based IDs)."
},
{
"name": "originatorLegalEntityType",
"value": "",
"type": "query",
"description": "Legal entity type override for the actual sender."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "POST the same recipient account payload that you will POST to `/v1/accounts`.\n\nUse this endpoint after setting any field that has `refreshRequirementsOnChange=true` in the GET response,\nto discover any additional required fields.\n\nSee the [GET endpoint](/api-reference/recipient/recipientaccountrequirementsget) for a full overview of how the account requirements flow works.\n"
},
{
"info": {
"name": "Check account and quote compatibility (v1)",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v1/accounts/:accountId/quotes/:quoteId/compatibility",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "Recipient account ID."
},
{
"name": "quoteId",
"value": "",
"type": "path",
"description": "Quote ID."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "{% admonition type=\"warning\" %}\nThis is a deprecated v1 endpoint. For new integrations please use the [v2 compatibility endpoint](/api-reference/recipient/recipientcompatibilitycheck).\n{% /admonition %}\n\n{% admonition type=\"info\" %}\nUse this version if you are fetching recipients through the v1 API. There are no functional differences between v1 and v2, but the field paths referenced in the response differ between the v1 and v2 recipient resources.\n{% /admonition %}\n\nUse this endpoint to check t"
},
{
"info": {
"name": "Check account and quote compatibility",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v2/accounts/:accountId/quotes/:quoteId/compatibility",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "Recipient account ID."
},
{
"name": "quoteId",
"value": "",
"type": "path",
"description": "Quote ID."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Use this endpoint to check the compatibility of a recipient account with a quote before creating a transfer. This validation includes:\n\n- Re-validating the recipient account details\n- Checking all required fields are present (e.g., recipient address for USD transfers)\n- Verifying account details with the recipient's bank (for supported currencies)\n\nThis endpoint is optional but useful to identify potential issues before transfer creation.\n\n{% admonition type=\"info\" %}\nThe confirmations field is "
},
{
"info": {
"name": "Accept confirmation outcomes",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.wise.com/v2/accounts/:accountId/confirmations",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "Recipient account ID."
},
{
"name": "quoteId",
"value": "",
"type": "query",
"description": "Required if the confirmation result contained a `quoteId`."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "When `requiresCustomerAcceptance` is `true` in the confirmation outcomes, the recipient cannot be used for a transfer until the customer explicitly confirms the details. You must present the mismatch to the customer and get their approval.\n\n{% admonition type=\"warning\" %}\nIf the confirmation result contained a `quoteId` then the acceptance request must also specify that as part of the query parameters, otherwise the request will be rejected.\n{% /admonition %}\n"
}
]
},
{
"info": {
"name": "simulation",
"type": "folder"
},
"items": [
{
"info": {
"name": "Simulate transfer state change",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v1/simulation/transfers/:transferId/:status",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "transferId",
"value": "",
"type": "path",
"description": "The ID of the transfer to simulate."
},
{
"name": "status",
"value": "",
"type": "path",
"description": "The target transfer status."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Changes the transfer status to the specified state. The available state transitions are:\n\n- `processing` — from `incoming_payment_waiting`\n- `funds_converted` — from `processing`. Refer to regional guides for special regional requirements.\n- `outgoing_payment_sent` — from `funds_converted`\n- `bounced_back` — from `outgoing_payment_sent`\n- `funds_refunded` — from `bounced_back`. Will not trigger a refund webhook.\n\n{% admonition type=\"warning\" %}\nSimulation does not work with email transfers.\n{% /"
},
{
"info": {
"name": "Simulate verification for a profile",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v1/simulation/profiles/:profileId/verifications",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "The ID of the profile to verify."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Changes a specific profile's verification state to `PASSED`.\n\nThis is useful for testing the `profiles#verification-state-change` webhook and is a prerequisite for setting up a Multi-Currency Account (MCA).\n\nAccepts both user and application API tokens.\n"
},
{
"info": {
"name": "Simulate verification for all profiles",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v1/simulation/verify-profile",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Verifies all profiles associated with the authenticated user, changing their verification state to `PASSED`.\n\nThis is useful for testing the `profiles#verification-state-change` webhook and is a prerequisite for setting up a Multi-Currency Account (MCA).\n\nAccepts user API tokens only. The profiles are identified via the token.\n"
},
{
"info": {
"name": "Simulate a balance top-up",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v1/simulation/balance/topup",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Simulates a top-up so that a balance can be used to fund transfers and/or card spend.\n"
},
{
"info": {
"name": "Simulate a card transaction authorisation",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v2/simulation/spend/profiles/:profileId/cards/:cardToken/transactions/authorisation",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "The profile ID."
},
{
"name": "cardToken",
"value": "",
"type": "path",
"description": "The card token."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Simulates a card transaction authorisation request in the sandbox environment. It can simulate ATM withdrawals, POS purchases, e-commerce transactions, and refunds. This is an authorisation hold, where funds are held, but not yet captured by the acquirer.\n\nThe `cardNumber` represents the 16-digit Primary Account Number (PAN) of the card, and must be a valid PAN retrieved from sensitive card details. Please follow the [detailed guide](/guides/product/issue-cards/sensitive-card-details) on retriev"
},
{
"info": {
"name": "Simulate a card transaction clearing",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v1/simulation/spend/profiles/:profileId/cards/:cardToken/transactions/clearing",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "The profile ID."
},
{
"name": "cardToken",
"value": "",
"type": "path",
"description": "The card token."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Simulates a transaction clearing request in the sandbox environment. This is done after the authorisation. The `ref` field can be copied from the `reference` object in the authorisation response.\n\nTo clear a previous authorisation, the `ref` details must match the previous authorisation request. The `amount` does not have to match the previous authorisation request, it can be more or less than the authorisation request amount.\n\n{% admonition type=\"warning\" %}\nClearing simulation doesn't work wit"
},
{
"info": {
"name": "Simulate a card transaction reversal",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v1/simulation/spend/profiles/:profileId/cards/:cardToken/transactions/reversal",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "The profile ID."
},
{
"name": "cardToken",
"value": "",
"type": "path",
"description": "The card token."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Simulates a transaction reversal request in the sandbox environment. The `amount.value` field can be set to 0 for a full reversal, or a positive value that represents the intended final value of the transaction after a partial reversal.\n\nFor example, if a transaction value was originally 10 SGD, and the intended final value is 3 SGD, `amount.value` should be set to 3. This means there is a partial refund of 7 SGD.\n"
},
{
"info": {
"name": "List simulated card transactions",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v2/simulation/spend/profiles/:profileId/cards/:cardToken/transactions",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "The profile ID."
},
{
"name": "cardToken",
"value": "",
"type": "path",
"description": "The card token."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "The maximum number of transactions to return. The default value is 10."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns a list of simulated card transactions, in descending order of creation time.\n\nTo retrieve more details of a transaction, use the [get card transaction by ID](/api-reference/card-transaction/cardtransactionget) endpoint.\n"
},
{
"info": {
"name": "Simulate card production state change",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v1/simulation/spend/profiles/:profileId/cards/:cardToken/production",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "The profile ID."
},
{
"name": "cardToken",
"value": "",
"type": "path",
"description": "The card token."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Simulates a card production status change in the sandbox environment.\n\n{% admonition type=\"warning\" %}\nPlease ensure that you have created a physical card order with KIOSK_COLLECTION delivery method and that you produce the card before calling this endpoint to simulate various card production statuses.\n{% /admonition %}\n"
},
{
"info": {
"name": "List KYC review requirements",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v2/simulation/profiles/:profileId/kyc-reviews/:kycReviewId/requirements",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "The profile ID."
},
{
"name": "kycReviewId",
"value": "",
"type": "path",
"description": "The ID of the existing KYC review."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Lists all blocking requirements for a KYC (Know Your Customer) review. These outstanding KYC requirements typically act as \"blocking requirements\", preventing actions like creating transfers.\n"
},
{
"info": {
"name": "Simulate adding new requirement",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v2/simulation/profiles/:profileId/kyc-reviews/:kycReviewId/requirements/add",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "The profile ID requiring the new requirement to be added."
},
{
"name": "kycReviewId",
"value": "",
"type": "path",
"description": "The ID of the existing KYC review."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Creates a new requirement for a KYC (Know Your Customer) review for a business profile.\n\n{% admonition type=\"warning\" %}\nThis can only be used for business profiles. It creates a static `BUSINESS_USE_CASE` requirement only.\n{% /admonition %}\n"
},
{
"info": {
"name": "Simulate requirement submission",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v2/simulation/profiles/:profileId/kyc-reviews/:kycReviewId/requirements/submit",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "The profile ID."
},
{
"name": "kycReviewId",
"value": "",
"type": "path",
"description": "The ID of the existing KYC review."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Simulates providing everything needed for a particular KYC requirement. This can be used in place of going through a hosted journey on the browser.\n\n{% admonition type=\"info\" %}\nThis functionality only works for the following requirements: `TRANSFER_PURPOSE`, `ID_DOCUMENT_WITH_LIVENESS`, `SOURCE_OF_FUNDS`, and any other that has the `___` delimiter in them.\n{% /admonition %}\n"
},
{
"info": {
"name": "Simulate verifying a KYC review",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v2/simulation/profiles/:profileId/kyc-reviews/:kycReviewId/verify",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "The profile ID."
},
{
"name": "kycReviewId",
"value": "",
"type": "path",
"description": "The ID of the existing KYC review."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Verifies requirement(s) on an existing KYC (Know Your Customer) review. Can be used after a user has provided input for a requirement through the hosted journey or simulated the requirement submission.\n"
},
{
"info": {
"name": "Simulate incoming bank transfer",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v1/simulation/profiles/:profileId/bank-transactions/import",
"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": "Simulates a bank transfer into a profile's account details. This will create a payment into the user's account details and balance for the specified amount and currency.\n\nPlease refer to the [Bank Account Details API reference](/api-reference/bank-account-details) for more information on setting up bank details to receive money.\n\n{% admonition type=\"info\" %}\nThis functionality only works for the following currencies: `USD`, `EUR`, `GBP`. Returns a 400 error when account details for the specified"
},
{
"info": {
"name": "Simulate incoming Swift payment",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v1/simulation/profiles/:profileId/swift-in",
"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": "Simulates an incoming Swift transfer into a profile's account details. This will create a payment into the user's account details and balance for the specified amount and currency. Using sandbox, you can test the initial tech build for webhook subscriptions, balance statements, and sweeping funds.\n\nIf the request is successful the transfer is logged in our back office, which triggers a [swift-in#credit](/guides/developer/webhooks/event-types#swift-in-credit) event and results in a balance update"
}
]
},
{
"info": {
"name": "spend-controls",
"type": "folder"
},
"items": [
{
"info": {
"name": "List all authorisation rules",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v3/spend/applications/:clientId/spend-controls/rules",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "clientId",
"value": "",
"type": "path",
"description": "The application client ID."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieves all the existing authorisation rules, regardless of whether or not they are applied.\n"
},
{
"info": {
"name": "Add a new authorisation rule",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v3/spend/applications/:clientId/spend-controls/rules",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "clientId",
"value": "",
"type": "path",
"description": "The application client ID."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Creates an authorisation rule. It won't be enabled unless it is [applied](/api-reference/spend-controls/spendcontrolsruleapply).\n\n{% admonition type=\"warning\" %}\nAn `ALLOW` rule permits only the transactions that match the specified criteria and blocks all others. For instance, a rule allowing `SGD` transactions will block all transactions that are not in `SGD`.\n{% /admonition %}\n"
},
{
"info": {
"name": "Apply an authorisation rule",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v3/spend/applications/:clientId/spend-controls/rules/apply",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "clientId",
"value": "",
"type": "path",
"description": "The application client ID."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Apply an authorisation rule. This will result in the rule being evaluated against every incoming card authorisation request.\n"
},
{
"info": {
"name": "Unapply an authorisation rule",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v3/spend/applications/:clientId/spend-controls/rules/unapply",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "clientId",
"value": "",
"type": "path",
"description": "The application client ID."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Deactivates an authorisation rule. This will result in all card transactions **not** being evaluated against this rule.\n\nThe rule still [exists](/api-reference/spend-controls/spendcontrolsruleslist) and can be [applied](/api-reference/spend-controls/spendcontrolsruleapply) again.\n"
},
{
"info": {
"name": "List applied authorisation rules",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v3/spend/applications/:clientId/spend-controls/rules/applied",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "clientId",
"value": "",
"type": "path",
"description": "The application client ID."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns the list of all the active authorisation rules that have been applied.\n"
},
{
"info": {
"name": "Delete an authorisation rule",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.wise.com/v3/spend/applications/:clientId/spend-controls/rules/:ruleId",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "clientId",
"value": "",
"type": "path",
"description": "The application client ID."
},
{
"name": "ruleId",
"value": "",
"type": "path",
"description": "The ID of the authorisation rule to delete."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Deletes an authorisation rule that is **currently not applied**.\nIf a rule is applied, you should [unapply](/api-reference/spend-controls/spendcontrolsruleunapply) the rule before deleting it.\n"
}
]
},
{
"info": {
"name": "spend-limits",
"type": "folder"
},
"items": [
{
"info": {
"name": "Retrieve profile limits",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v4/spend/profiles/:profileId/spend-limits",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "The profile ID."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieves the spend limits that are configured for a profile.\n"
},
{
"info": {
"name": "Update profile limits",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.wise.com/v4/spend/profiles/:profileId/spend-limits",
"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": "Update profile daily and monthly spend limits for `PURCHASE` or `ATM_WITHDRAWAL`. Both daily and monthly must be set.\n"
},
{
"info": {
"name": "Retrieve card limits",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v4/spend/profiles/:profileId/cards/:cardToken/spend-limits",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "The profile ID."
},
{
"name": "cardToken",
"value": "",
"type": "path",
"description": "The card token."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieves the spend limits that are configured for a card.\n"
},
{
"info": {
"name": "Create or update card limits",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.wise.com/v4/spend/profiles/:profileId/cards/:cardToken/spend-limits",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "The profile ID."
},
{
"name": "cardToken",
"value": "",
"type": "path",
"description": "The card token."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create or update card transaction, daily, monthly or lifetime spend limits.\n"
},
{
"info": {
"name": "Delete card limits",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.wise.com/v4/spend/profiles/:profileId/cards/:cardToken/spend-limits/:granularity",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "The profile ID."
},
{
"name": "cardToken",
"value": "",
"type": "path",
"description": "The card token."
},
{
"name": "granularity",
"value": "",
"type": "path",
"description": "The limit granularity to delete."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete card spend limits for a specific granularity.\n"
},
{
"info": {
"name": "Retrieve profile spend limits",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v3/spend/profiles/:profileId/spending-limits",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "The profile ID."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieves the spending limits that are configured for a profile.\n\n{% admonition type=\"warning\" %}\nThis endpoint has been deprecated. Use [Retrieve profile limits](/api-reference/spend-limits/spendlimitsprofileget) instead.\n{% /admonition %}\n"
}
]
},
{
"info": {
"name": "sca-sessions",
"type": "folder"
},
"items": [
{
"info": {
"name": "Create a SCA session",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v2/profiles/:profileId/sca-sessions/authorise",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "The profile ID."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Manually triggers SCA, returning a one-time token along with a list of associated challenges. These challenges can be cleared with the verify endpoints.\n"
}
]
},
{
"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 "
}
]
},
{
"info": {
"name": "user",
"type": "folder"
},
"items": [
{
"info": {
"name": "Retrieve current user by token",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v1/me",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get authenticated user details for the user's token submitted in the Authorization header.\n"
},
{
"info": {
"name": "Retrieve a user by ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v1/users/:userId",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "userId",
"value": "101",
"type": "path",
"description": "The user ID."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get authenticated user details by user ID.\n"
},
{
"info": {
"name": "Create a user with a registration code",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v1/user/signup/registration_code",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Wise uses email address as unique identifier for users. If email is new (there is no active user already) then a new user will be created.\n\nWhen you are submitting an email which already exists amongst our users then you will get a warning that \"You're already a member. Please login\". If user already exists then you need to redirect to \"Get user authorization\" webpage.\n"
},
{
"info": {
"name": "Check if user exists",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v1/users/exists",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Check if a user already exists by email. Wise uses email address as unique identifier for users. If email has already been used by a user, it cannot be reused to create a new user.\n\nNote that this uses a `client-credentials-token` and not a `user access_token` for authentication.\n"
},
{
"info": {
"name": "Retrieve a contact email address",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v1/users/:userId/contact-email",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "userId",
"value": "101",
"type": "path",
"description": "The user ID."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieves a contact email address."
},
{
"info": {
"name": "Set a contact email address",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.wise.com/v1/users/:userId/contact-email",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "userId",
"value": "101",
"type": "path",
"description": "The user ID."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Sets a contact email address. The contact email address is used to send notifications to users who have been registered with a dummy email address.\n"
}
]
},
{
"info": {
"name": "webhook",
"type": "folder"
},
"items": [
{
"info": {
"name": "List Application Webhook Subscriptions",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v3/applications/:clientKey/subscriptions",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "clientKey",
"value": "",
"type": "path",
"description": "Your application's client key."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List all webhook subscriptions for your application."
},
{
"info": {
"name": "Create Application Webhook Subscription",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v3/applications/:clientKey/subscriptions",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "clientKey",
"value": "",
"type": "path",
"description": "Your application's client key."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create a webhook subscription at the application level.\n\n`clientKey` can be received upon obtaining client credentials from our tech support.\n"
},
{
"info": {
"name": "Get Application Webhook Subscription",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v3/applications/:clientKey/subscriptions/:subscriptionId",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "clientKey",
"value": "",
"type": "path",
"description": "Your application's client key."
},
{
"name": "subscriptionId",
"value": "",
"type": "path",
"description": "UUID of the subscription."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve an application webhook subscription by its identifier."
},
{
"info": {
"name": "Delete Application Webhook Subscription",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.wise.com/v3/applications/:clientKey/subscriptions/:subscriptionId",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "clientKey",
"value": "",
"type": "path",
"description": "Your application's client key."
},
{
"name": "subscriptionId",
"value": "",
"type": "path",
"description": "UUID of the subscription."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete an application webhook subscription by its identifier."
},
{
"info": {
"name": "Test Application Webhook Subscription",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v3/applications/:clientKey/subscriptions/:subscriptionId/test-notifications",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "clientKey",
"value": "",
"type": "path",
"description": "Your application's client key."
},
{
"name": "subscriptionId",
"value": "",
"type": "path",
"description": "UUID of the subscription."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Generate test notifications for an existing application subscription.\n\nTest notifications will have the correct structure for their source subscription's event type and version, and will contain \"dummy\" data. These data include random UUIDs, entity IDs of zero, current dates and times, and hard-coded status codes.\n\nTest notifications are delivered with the usual notification HTTP request headers, including a unique delivery ID for the notification, and a \"test notification\" flag set to true. You"
},
{
"info": {
"name": "List Profile Webhook Subscriptions",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v3/profiles/:profileId/subscriptions",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "ID of the profile."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List all webhook subscriptions for a profile."
},
{
"info": {
"name": "Create Profile Webhook Subscription",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.wise.com/v3/profiles/:profileId/subscriptions",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "ID of the profile you are subscribing to."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create a webhook subscription at the profile level."
},
{
"info": {
"name": "Get Profile Webhook Subscription",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.wise.com/v3/profiles/:profileId/subscriptions/:subscriptionId",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "ID of the profile."
},
{
"name": "subscriptionId",
"value": "",
"type": "path",
"description": "UUID of the subscription."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve a profile webhook subscription by its identifier."
},
{
"info": {
"name": "Delete Profile Webhook Subscription",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.wise.com/v3/profiles/:profileId/subscriptions/:subscriptionId",
"headers": [
{
"name": "X-External-Correlation-Id",
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "ID of the profile."
},
{
"name": "subscriptionId",
"value": "",
"type": "path",
"description": "UUID of the subscription."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete a profile webhook subscription by its identifier."
}
]
}
],
"bundled": true
}