{"items":[{"type":"link","label":"Wise Platform API","link":"/api-reference","routeSlug":"/api-reference","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"separator","label":"Authentication","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"group","label":"OAuth Token","link":"/api-reference/oauth-token","routeSlug":"/api-reference/oauth-token","items":[{"label":"Create an OAuth token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/oauth-token/oauthtokencreate","routeSlug":"/api-reference/oauth-token/oauthtokencreate","metadata":{"seo":{"title":"Create an OAuth token","description":"Exchange credentials or authorisation grants for an OAuth 2.0 access token."}},"httpPath":"/oauth/token","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"}],"version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"separator","label":"Enhanced Security","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"group","label":"JOSE","link":"/api-reference/jose","routeSlug":"/api-reference/jose","items":[{"label":"Get Wise JOSE public key","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/jose/joseresponsepublickeysget","routeSlug":"/api-reference/jose/joseresponsepublickeysget","metadata":{"seo":{"title":"Get Wise JOSE public key","description":"Returns a public key issued by Wise."}},"httpPath":"/auth/jose/response/public-keys","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Add a new client public key","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/jose/joserequestpublickeyscreate","routeSlug":"/api-reference/jose/joserequestpublickeyscreate","metadata":{"seo":{"title":"Add a new client public key","description":"Upload a client public key for request payload signing or response payload encryption."}},"httpPath":"/auth/jose/request/public-keys","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Playground JWS","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/jose/joseplaygroundjws","routeSlug":"/api-reference/jose/joseplaygroundjws","metadata":{"seo":{"title":"Playground JWS","description":"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."}},"httpPath":"/auth/jose/playground/jws","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Playground JWE for GET requests","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/jose/joseplaygroundjweget","routeSlug":"/api-reference/jose/joseplaygroundjweget","metadata":{"seo":{"title":"Playground JWE for GET requests","description":"Send test HTTP GET requests and receive encrypted responses."}},"httpPath":"/auth/jose/playground/jwe","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Playground JWE for POST requests","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/jose/joseplaygroundjwepost","routeSlug":"/api-reference/jose/joseplaygroundjwepost","metadata":{"seo":{"title":"Playground JWE for POST requests","description":"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."}},"httpPath":"/auth/jose/playground/jwe","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Playground JWE for direct encryption","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/jose/joseplaygroundjwedirectencryption","routeSlug":"/api-reference/jose/joseplaygroundjwedirectencryption","metadata":{"seo":{"title":"Playground JWE for direct encryption","description":"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."}},"httpPath":"/auth/jose/playground/jwe-direct-encryption","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Playground JWS+JWE","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/jose/joseplaygroundjwsjwe","routeSlug":"/api-reference/jose/joseplaygroundjwsjwe","metadata":{"seo":{"title":"Playground JWS+JWE","description":"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."}},"httpPath":"/auth/jose/playground/jwsjwe","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"}],"version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"separator","label":"Users","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Users","link":"/api-reference/user","routeSlug":"/api-reference/user","items":[{"type":"link","label":"User","link":"/api-reference/user/user","routeSlug":"/api-reference/user/user","httpVerb":"schema","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Retrieve current user by token","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/user/usergetbytoken","routeSlug":"/api-reference/user/usergetbytoken","metadata":{"seo":{"title":"Retrieve current user by token","description":"Get authenticated user details for the user's token submitted in the Authorization header."}},"httpPath":"/me","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Retrieve a user by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/user/usergetbyid","routeSlug":"/api-reference/user/usergetbyid","metadata":{"seo":{"title":"Retrieve a user by ID","description":"Get authenticated user details by user ID."}},"httpPath":"/users/{userId}","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Create a user with a registration code","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/user/usercreate","routeSlug":"/api-reference/user/usercreate","metadata":{"seo":{"title":"Create a user with a registration code","description":"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."}},"httpPath":"/user/signup/registration_code","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Check if user exists","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/user/usercheckexists","routeSlug":"/api-reference/user/usercheckexists","metadata":{"seo":{"title":"Check if user exists","description":"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."}},"httpPath":"/users/exists","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Set a contact email address","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/user/usercontactemailset","routeSlug":"/api-reference/user/usercontactemailset","metadata":{"seo":{"title":"Set a contact email address","description":"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."}},"httpPath":"/users/{userId}/contact-email","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Retrieve a contact email address","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/user/usercontactemailget","routeSlug":"/api-reference/user/usercontactemailget","metadata":{"seo":{"title":"Retrieve a contact email address","description":"Retrieves a contact email address."}},"httpPath":"/users/{userId}/contact-email","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"separator","label":"Webhooks","variant":"secondary","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"User state change","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/user/eventusersstatechange","routeSlug":"/api-reference/user/eventusersstatechange","metadata":{"seo":{"title":"User state change","description":"Triggered every time a user's state is updated."}},"httpPath":"users#state-change","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"}],"version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Claim Account","link":"/api-reference/claim-account","routeSlug":"/api-reference/claim-account","items":[{"label":"Generate a claim account code","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/claim-account/claimaccountcreate","routeSlug":"/api-reference/claim-account/claimaccountcreate","metadata":{"seo":{"title":"Generate a claim account code","description":"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 to finalize their account setup."}},"httpPath":"/user/claim-account","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"}],"version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"separator","label":"Profiles","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Profiles","link":"/api-reference/profile","routeSlug":"/api-reference/profile","items":[{"type":"link","label":"Profile","link":"/api-reference/profile/profile","routeSlug":"/api-reference/profile/profile","httpVerb":"schema","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"List profiles for a user account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/profile/profilelist","routeSlug":"/api-reference/profile/profilelist","metadata":{"seo":{"title":"List profiles for a user account","description":"List of all profiles belonging to user."}},"httpPath":"/profiles","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Create a personal profile","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/profile/profilepersonalcreate","routeSlug":"/api-reference/profile/profilepersonalcreate","metadata":{"seo":{"title":"Create a personal profile","description":"Create a personal profile for the authenticated user. A personal profile represents an individual and is required before creating transfers or business profiles."}},"httpPath":"/profiles/personal-profile","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Create a business profile","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/profile/profilebusinesscreatev5","routeSlug":"/api-reference/profile/profilebusinesscreatev5","metadata":{"seo":{"title":"Create a business profile","description":"Creates the business profile and its authorized representative in a single request."}},"httpPath":"/profiles/business-profile","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Retrieve a profile by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/profile/profileget","routeSlug":"/api-reference/profile/profileget","metadata":{"seo":{"title":"Retrieve a profile by ID","description":"Get profile info by ID."}},"httpPath":"/profiles/{profileId}","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Update a personal profile","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/profile/profilepersonalupdate","routeSlug":"/api-reference/profile/profilepersonalupdate","metadata":{"seo":{"title":"Update a personal profile","description":"Update user profile information for a personal profile."}},"httpPath":"/profiles/{profileId}/personal-profile","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Update a business profile","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/profile/profilebusinessupdatev3","routeSlug":"/api-reference/profile/profilebusinessupdatev3","metadata":{"seo":{"title":"Update a business profile","description":"Update user profile information for a business profile."}},"httpPath":"/profiles/{profileId}/business-profile","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Retrieve business representative","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/profile/profilebusinessrepresentativeget","routeSlug":"/api-reference/profile/profilebusinessrepresentativeget","metadata":{"seo":{"title":"Retrieve business representative","description":"Get Business Representative info by Business Profile ID."}},"httpPath":"/profiles/{profileId}/business-profile/business-representative","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Update business representative","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/profile/profilebusinessrepresentativeupdate","routeSlug":"/api-reference/profile/profilebusinessrepresentativeupdate","metadata":{"seo":{"title":"Update business representative","description":"Update or transfer the Business Representative for the specified Business Profile."}},"httpPath":"/profiles/{profileId}/business-profile/business-representative","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Create an identification document","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/profile/profileverificationdocumentcreate","routeSlug":"/api-reference/profile/profileverificationdocumentcreate","metadata":{"seo":{"title":"Create an identification document","description":"Add an identification document to a personal profile. Not applicable to business profiles."}},"httpPath":"/profiles/{profileId}/verification-documents","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Update an identification document","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/profile/profileverificationdocumentupdate","routeSlug":"/api-reference/profile/profileverificationdocumentupdate","metadata":{"seo":{"title":"Update an identification document","description":"Update an existing identification document on a personal profile. Not applicable to business profiles."}},"httpPath":"/profiles/{profileId}/verification-documents","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Create business directors","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/profile/profiledirectorcreate","routeSlug":"/api-reference/profile/profiledirectorcreate","metadata":{"seo":{"title":"Create business directors","description":"Adds new directors to the business profile."}},"httpPath":"/profiles/{profileId}/directors","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"List business directors","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/profile/profiledirectorlist","routeSlug":"/api-reference/profile/profiledirectorlist","metadata":{"seo":{"title":"List business directors","description":"Returns the list of director objects associated with the business profile."}},"httpPath":"/profiles/{profileId}/directors","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Update business directors","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/profile/profiledirectorupdate","routeSlug":"/api-reference/profile/profiledirectorupdate","metadata":{"seo":{"title":"Update business directors","description":"Overrides directors in the business profile."}},"httpPath":"/profiles/{profileId}/directors","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Create business ultimate owners","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/profile/profileubocreate","routeSlug":"/api-reference/profile/profileubocreate","metadata":{"seo":{"title":"Create business ultimate owners","description":"Adds new ultimate beneficial owners to the business profile."}},"httpPath":"/profiles/{profileId}/ubos","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"List business ultimate owners","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/profile/profileubolist","routeSlug":"/api-reference/profile/profileubolist","metadata":{"seo":{"title":"List business ultimate owners","description":"Returns the list of all ultimate beneficial owners associated with the business profile."}},"httpPath":"/profiles/{profileId}/ubos","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Update business ultimate owners","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/profile/profileuboupdate","routeSlug":"/api-reference/profile/profileuboupdate","metadata":{"seo":{"title":"Update business ultimate owners","description":"Overrides ultimate beneficial owners in the business profile."}},"httpPath":"/profiles/{profileId}/ubos","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Open an update window","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/profile/profileupdatewindowopen","routeSlug":"/api-reference/profile/profileupdatewindowopen","metadata":{"seo":{"title":"Open an update window","description":"Opens the update window for updating the profile information: details, addresses, directors, owners, others."}},"httpPath":"/profiles/{profileId}/update-window","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Close an update window","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/profile/profileupdatewindowclose","routeSlug":"/api-reference/profile/profileupdatewindowclose","metadata":{"seo":{"title":"Close an update window","description":"Deletes the update window for updating the profile."}},"httpPath":"/profiles/{profileId}/update-window","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Check profile verification status","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/profile/profileverificationstatuscheck","routeSlug":"/api-reference/profile/profileverificationstatuscheck","metadata":{"seo":{"title":"Check profile verification status","description":"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."}},"httpPath":"/profiles/{profileId}/verification-status/bank-transfer","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"separator","label":"Webhooks","variant":"secondary","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Overdraft limit threshold","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/profile/eventprofilesoverdraftlimitthreshold","routeSlug":"/api-reference/profile/eventprofilesoverdraftlimitthreshold","metadata":{"seo":{"title":"Overdraft limit threshold","description":"Triggered when the overdraft limit usage has reached 70% threshold. The event at each threshold is triggered maximum once per hour."}},"httpPath":"profiles#overdraft-limit-threshold","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Profile state change","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/profile/eventprofilesstatechange","routeSlug":"/api-reference/profile/eventprofilesstatechange","metadata":{"seo":{"title":"Profile state change","description":"Triggered every time a profile's state is updated."}},"httpPath":"profiles#state-change","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Verification state change","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/profile/eventprofilesverificationstatechange","routeSlug":"/api-reference/profile/eventprofilesverificationstatechange","metadata":{"seo":{"title":"Verification state change","description":"Triggered when the verification state of a connected profile changes."}},"httpPath":"profiles#verification-state-change","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"}],"version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Activity","link":"/api-reference/activity","routeSlug":"/api-reference/activity","items":[{"label":"List Activities for a Profile","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/activity/activitylist","routeSlug":"/api-reference/activity/activitylist","metadata":{"seo":{"title":"List Activities for a Profile","description":"List of activities belonging to user profile."}},"httpPath":"/profiles/{profileId}/activities","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"}],"version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Addresses","link":"/api-reference/address","routeSlug":"/api-reference/address","items":[{"type":"link","label":"Address","link":"/api-reference/address/address","routeSlug":"/api-reference/address/address","httpVerb":"schema","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Create or Update an Address","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/address/addresscreate","routeSlug":"/api-reference/address/addresscreate","metadata":{"seo":{"title":"Create or Update an Address","description":"Adds address info to user profile."}},"httpPath":"/addresses","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"List Addresses for a Profile","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/address/addresslist","routeSlug":"/api-reference/address/addresslist","metadata":{"seo":{"title":"List Addresses for a Profile","description":"List of addresses belonging to user profile."}},"httpPath":"/addresses","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Retrieve an Address by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/address/addressget","routeSlug":"/api-reference/address/addressget","metadata":{"seo":{"title":"Retrieve an Address by ID","description":"Get address info by ID."}},"httpPath":"/addresses/{addressId}","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Get Address Requirements","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/address/addressrequirementsget","routeSlug":"/api-reference/address/addressrequirementsget","metadata":{"seo":{"title":"Get Address Requirements","description":"Returns the list of fields required to create a valid address. Use this as a starting point to discover required fields."}},"httpPath":"/address-requirements","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Get Address Requirements (with context)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/address/addressrequirementspost","routeSlug":"/api-reference/address/addressrequirementspost","metadata":{"seo":{"title":"Get Address Requirements (with context)","description":"Returns the list of fields required to create a valid address, based on the provided context."}},"httpPath":"/address-requirements","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"}],"version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"separator","label":"Verification","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"group","label":"KYC Review","link":"/api-reference/kyc-review","routeSlug":"/api-reference/kyc-review","items":[{"type":"link","label":"KYC Requirement","link":"/api-reference/kyc-review/kyc-requirement","routeSlug":"/api-reference/kyc-review/kyc-requirement","httpVerb":"schema","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"link","label":"KYC Review","link":"/api-reference/kyc-review/kyc-review","routeSlug":"/api-reference/kyc-review/kyc-review","httpVerb":"schema","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"link","label":"KYC Review with a Hosted KYC link","link":"/api-reference/kyc-review/kyc-review-with-link","routeSlug":"/api-reference/kyc-review/kyc-review-with-link","httpVerb":"schema","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Create a KYC Review","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/kyc-review/kycreviewcreate","routeSlug":"/api-reference/kyc-review/kycreviewcreate","metadata":{"seo":{"title":"Create a KYC Review","description":"Creates a KYC Review for a specific customer action."}},"httpPath":"/profiles/{profileId}/kyc-reviews","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Get all KYC Reviews for a profile","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/kyc-review/kycreviewlist","routeSlug":"/api-reference/kyc-review/kycreviewlist","metadata":{"seo":{"title":"Get all KYC Reviews for a profile","description":"Retrieves a list of all active KYC Reviews for a given profile."}},"httpPath":"/profiles/{profileId}/kyc-reviews","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Get KYC Review by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/kyc-review/kycreviewget","routeSlug":"/api-reference/kyc-review/kycreviewget","metadata":{"seo":{"title":"Get KYC Review by ID","description":"Retrieves a single KYC Review by ID for a profile."}},"httpPath":"/profiles/{profileId}/kyc-reviews/{kycReviewId}","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Update KYC Review to get a Hosted KYC link","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/kyc-review/kycreviewredirecturlupdate","routeSlug":"/api-reference/kyc-review/kycreviewredirecturlupdate","metadata":{"seo":{"title":"Update KYC Review to get a Hosted KYC link","description":"Updates the KYC Review with a redirect URL."}},"httpPath":"/profiles/{profileId}/kyc-reviews/{kycReviewId}","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Submit a KYC Requirement","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/kyc-review/kycreviewrequirementsubmit","routeSlug":"/api-reference/kyc-review/kycreviewrequirementsubmit","metadata":{"seo":{"title":"Submit a KYC Requirement","description":"Submit a KYC requirement for a KYC Review."}},"httpPath":"/profiles/{profileId}/kyc-requirements/{requirementKey}","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"separator","label":"Webhooks","variant":"secondary","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"KYC review state change","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/kyc-review/eventkycreviewsstatechange","routeSlug":"/api-reference/kyc-review/eventkycreviewsstatechange","metadata":{"seo":{"title":"KYC review state change","description":"Triggered when a KYC review state has changed."}},"httpPath":"kyc-reviews#state-change","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"}],"version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Additional Verification","link":"/api-reference/verification","routeSlug":"/api-reference/verification","items":[{"label":"Upload Evidences","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/verification/verificationuploadevidences","routeSlug":"/api-reference/verification/verificationuploadevidences","metadata":{"seo":{"title":"Upload Evidences","description":"Uploads verification evidence for a specific profile."}},"httpPath":"/profiles/{profileId}/additional-verification/upload-evidences","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Upload Document","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/verification/verificationuploaddocument","routeSlug":"/api-reference/verification/verificationuploaddocument","metadata":{"seo":{"title":"Upload Document","description":"Uploads verification documents for review. You can upload multiple files at once."}},"httpPath":"/profiles/{profileId}/verification-status/upload-document","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Required Evidences","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/verification/verificationgetrequiredevidences","routeSlug":"/api-reference/verification/verificationgetrequiredevidences","metadata":{"seo":{"title":"Required Evidences","description":"Fetches the required evidences for a profile to complete additional customer verification."}},"httpPath":"/profiles/{profileId}/verification-status/required-evidences","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"separator","label":"Webhooks","variant":"secondary","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Additional verification state change","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/verification/eventprofilescddcheckstatechange","routeSlug":"/api-reference/verification/eventprofilescddcheckstatechange","metadata":{"seo":{"title":"Additional verification state change","description":"This event pushes updates for the Additional Customer Verification process."}},"httpPath":"profiles#cdd-check-state-change","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"}],"version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"group","label":"FaceTec","link":"/api-reference/facetec","routeSlug":"/api-reference/facetec","items":[{"label":"Get FaceTec public key","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/facetec/facetecpublickeyget","routeSlug":"/api-reference/facetec/facetecpublickeyget","metadata":{"seo":{"title":"Get FaceTec public key","description":"Retrieve Wise's FaceTec public key to be used when exporting 3D FaceMap from your FaceTec host to Wise."}},"httpPath":"/facetec/public-key","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"}],"version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"separator","label":"Embedded Flows","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Link Requests","link":"/api-reference/link-requests","routeSlug":"/api-reference/link-requests","items":[{"label":"Recipient creation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/link-requests/recipientembeddedlinkrequestcreate","routeSlug":"/api-reference/link-requests/recipientembeddedlinkrequestcreate","metadata":{"seo":{"title":"Recipient creation","description":"Returns a link that allows a user to complete a recipient creation flow via either a redirect or embedded iframe/webview."}},"httpPath":"/profiles/{profileId}/embedded-flows/link-requests/recipients","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Payment instrument creation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/link-requests/paymentinstrumentembeddedlinkrequestcreate","routeSlug":"/api-reference/link-requests/paymentinstrumentembeddedlinkrequestcreate","metadata":{"seo":{"title":"Payment instrument creation","description":"Returns a link that allows a user to complete a payment instrument flow via either a redirect or embedded iframe/webview."}},"httpPath":"/profiles/{profileId}/embedded-flows/link-requests/payment-instrument","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"KYC review completion","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/link-requests/kycreviewsembeddedlinkrequestcreate","routeSlug":"/api-reference/link-requests/kycreviewsembeddedlinkrequestcreate","metadata":{"seo":{"title":"KYC review completion","description":"Returns a link that allows a user to complete a KYC review flow via either a redirect or embedded iframe/webview."}},"httpPath":"/profiles/{profileId}/embedded-flows/link-requests/kyc-reviews","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Get embedded flow configuration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/link-requests/embeddedlinkrequestget","routeSlug":"/api-reference/link-requests/embeddedlinkrequestget","metadata":{"seo":{"title":"Get embedded flow configuration","description":"Retrieves an Embedded Flow configuration by embedded link request ID. Typically this is not needed to be called as its used by the flow itself."}},"httpPath":"/embedded-flows/link-requests/{embeddedLinkRequestId}","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"}],"version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"separator","label":"Strong Customer Authentication","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"group","label":"One Time Token","link":"/api-reference/sca-ott","routeSlug":"/api-reference/sca-ott","items":[{"type":"link","label":"One-Time Token","link":"/api-reference/sca-ott/one-time-token","routeSlug":"/api-reference/sca-ott/one-time-token","httpVerb":"schema","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Get status of a one time token","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/sca-ott/ottstatusget","routeSlug":"/api-reference/sca-ott/ottstatusget","metadata":{"seo":{"title":"Get status of a one time token","description":"Retrieve necessary information to clear a OTT."}},"httpPath":"/one-time-token/status","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"}],"version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"group","label":"SCA Sessions","link":"/api-reference/sca-sessions","routeSlug":"/api-reference/sca-sessions","items":[{"label":"Create a SCA session","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/sca-sessions/scasessioncreate","routeSlug":"/api-reference/sca-sessions/scasessioncreate","metadata":{"seo":{"title":"Create a SCA session","description":"Manually triggers SCA, returning a one-time token along with a list of associated challenges. These challenges can be cleared with the verify endpoints."}},"httpPath":"/profiles/{profileId}/sca-sessions/authorise","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"}],"version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"group","label":"PIN","link":"/api-reference/sca-pin","routeSlug":"/api-reference/sca-pin","items":[{"label":"Create a PIN","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/sca-pin/scapincreate","routeSlug":"/api-reference/sca-pin/scapincreate","metadata":{"seo":{"title":"Create a PIN","description":"Creates a new PIN factor used to resolve a SCA knowledge challenge type."}},"httpPath":"/profiles/{profileId}/pin","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Delete a PIN","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/sca-pin/scapindelete","routeSlug":"/api-reference/sca-pin/scapindelete","metadata":{"seo":{"title":"Delete a PIN","description":"Deletes a PIN associated to a profile."}},"httpPath":"/profiles/{profileId}/pin","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Verify a PIN","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/sca-pin/scapinverify","routeSlug":"/api-reference/sca-pin/scapinverify","metadata":{"seo":{"title":"Verify a PIN","description":"Verifies a PIN challenge when calling a SCA-secured endpoint. Make sure to create a PIN before using this endpoint."}},"httpPath":"/profiles/{profileId}/pin/verify","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"}],"version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Facemaps","link":"/api-reference/sca-facemaps","routeSlug":"/api-reference/sca-facemaps","items":[{"label":"Create a facemap","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/sca-facemaps/scafacemapcreate","routeSlug":"/api-reference/sca-facemaps/scafacemapcreate","metadata":{"seo":{"title":"Create a facemap","description":"Creates a new facemap factor used to resolve a SCA inherence challenge type."}},"httpPath":"/profiles/{profileId}/facemaps","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Delete a facemap","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/sca-facemaps/scafacemapdelete","routeSlug":"/api-reference/sca-facemaps/scafacemapdelete","metadata":{"seo":{"title":"Delete a facemap","description":"Deletes a facemap associated to a profile."}},"httpPath":"/profiles/{profileId}/facemaps","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Verify a facemap","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/sca-facemaps/scafacemapverify","routeSlug":"/api-reference/sca-facemaps/scafacemapverify","metadata":{"seo":{"title":"Verify a facemap","description":"Verifies a facemap challenge when calling a SCA-secured endpoint. Make sure to create a facemap before using this endpoint."}},"httpPath":"/profiles/{profileId}/facemaps/verify","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"}],"version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Device Fingerprints","link":"/api-reference/sca-device-fingerprints","routeSlug":"/api-reference/sca-device-fingerprints","items":[{"label":"Create a device fingerprint","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/sca-device-fingerprints/scadevicefingerprintcreate","routeSlug":"/api-reference/sca-device-fingerprints/scadevicefingerprintcreate","metadata":{"seo":{"title":"Create a device fingerprint","description":"Creates a new device fingerprint factor used to resolve a SCA possession challenge type."}},"httpPath":"/profiles/{profileId}/device-fingerprints","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Verify a device fingerprint","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/sca-device-fingerprints/scadevicefingerprintverify","routeSlug":"/api-reference/sca-device-fingerprints/scadevicefingerprintverify","metadata":{"seo":{"title":"Verify a device fingerprint","description":"Verifies a device fingerprint challenge when calling a SCA-secured endpoint. Make sure to create a device fingerprint before using this endpoint."}},"httpPath":"/profiles/{profileId}/device-fingerprints/verify","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Delete a device fingerprint","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/sca-device-fingerprints/scadevicefingerprintdelete","routeSlug":"/api-reference/sca-device-fingerprints/scadevicefingerprintdelete","metadata":{"seo":{"title":"Delete a device fingerprint","description":"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."}},"httpPath":"/profiles/{profileId}/device-fingerprints/{deviceFingerprintId}","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"}],"version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"group","label":"OTP","link":"/api-reference/sca-otp","routeSlug":"/api-reference/sca-otp","items":[{"label":"Create Phone Number","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/sca-otp/usersecurityphonenumbercreate","routeSlug":"/api-reference/sca-otp/usersecurityphonenumbercreate","metadata":{"seo":{"title":"Create Phone Number","description":"Create a verified phone number for a user."}},"httpPath":"/application/users/{userId}/phone-numbers","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Trigger SMS Challenge","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/sca-otp/ottsmstrigger","routeSlug":"/api-reference/sca-otp/ottsmstrigger","metadata":{"seo":{"title":"Trigger SMS Challenge","description":"To trigger a SMS challenge by sending SMS to user verified phone number. Contains a 6 digit one time password (OTP)."}},"httpPath":"/one-time-token/sms/trigger","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Verify SMS Challenge","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/sca-otp/ottsmsverify","routeSlug":"/api-reference/sca-otp/ottsmsverify","metadata":{"seo":{"title":"Verify SMS Challenge","description":"To clear a SMS challenge listed in a OTT."}},"httpPath":"/one-time-token/sms/verify","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Trigger WhatsApp Challenge","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/sca-otp/ottwhatsapptrigger","routeSlug":"/api-reference/sca-otp/ottwhatsapptrigger","metadata":{"seo":{"title":"Trigger WhatsApp Challenge","description":"To trigger a WhatsApp challenge by sending WhatsApp message to user verified phone number. Contains a 6 digit one time password (OTP)."}},"httpPath":"/one-time-token/whatsapp/trigger","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Verify WhatsApp Challenge","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/sca-otp/ottwhatsappverify","routeSlug":"/api-reference/sca-otp/ottwhatsappverify","metadata":{"seo":{"title":"Verify WhatsApp Challenge","description":"To clear a WHATSAPP challenge listed in a OTT."}},"httpPath":"/one-time-token/whatsapp/verify","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Trigger Voice Challenge","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/sca-otp/ottvoicetrigger","routeSlug":"/api-reference/sca-otp/ottvoicetrigger","metadata":{"seo":{"title":"Trigger Voice Challenge","description":"To trigger a Voice challenge by sending voice message to user verified phone number. Contains a 6 digit one time password (OTP)."}},"httpPath":"/one-time-token/voice/trigger","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Verify Voice Challenge","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/sca-otp/ottvoiceverify","routeSlug":"/api-reference/sca-otp/ottvoiceverify","metadata":{"seo":{"title":"Verify Voice Challenge","description":"To clear a VOICE challenge listed in a OTT."}},"httpPath":"/one-time-token/voice/verify","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Delete Phone Number","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/sca-otp/usersecurityphonenumberdelete","routeSlug":"/api-reference/sca-otp/usersecurityphonenumberdelete","metadata":{"seo":{"title":"Delete Phone Number","description":"Delete a verified phone number for a user."}},"httpPath":"/application/users/{userId}/phone-numbers/{phoneNumberId}","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"}],"version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"separator","label":"Balances","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Balances","link":"/api-reference/balance","routeSlug":"/api-reference/balance","items":[{"type":"link","label":"Balance","link":"/api-reference/balance/balance","routeSlug":"/api-reference/balance/balance","httpVerb":"schema","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"link","label":"HoldLimitBreach","link":"/api-reference/balance/holdlimitbreach","routeSlug":"/api-reference/balance/holdlimitbreach","httpVerb":"schema","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Create a Balance Account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/balance/balancecreate","routeSlug":"/api-reference/balance/balancecreate","metadata":{"seo":{"title":"Create a Balance Account","description":"Opens a balance within the specified profile, in the currency and type specified in the request."}},"httpPath":"/profiles/{profileId}/balances","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"List Balances for a Profile","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/balance/balancelist","routeSlug":"/api-reference/balance/balancelist","metadata":{"seo":{"title":"List Balances for a Profile","description":"Retrieves the user's multi-currency account balance accounts. Returns all balance accounts the profile has in the types specified."}},"httpPath":"/profiles/{profileId}/balances","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Retrieve a Balance by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/balance/balanceget","routeSlug":"/api-reference/balance/balanceget","metadata":{"seo":{"title":"Retrieve a Balance by ID","description":"Returns a balance based on the specified balance ID."}},"httpPath":"/profiles/{profileId}/balances/{balanceId}","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Remove a Balance Account","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/balance/balancedelete","routeSlug":"/api-reference/balance/balancedelete","metadata":{"seo":{"title":"Remove a Balance Account","description":"Closes a balance account for the user's profile."}},"httpPath":"/profiles/{profileId}/balances/{balanceId}","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Convert or Move Money Between Balances","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/balance/balancemovement","routeSlug":"/api-reference/balance/balancemovement","metadata":{"seo":{"title":"Convert or Move Money Between Balances","description":"This endpoint allows conversion and movement of funds between balance accounts."}},"httpPath":"/profiles/{profileId}/balance-movements","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Retrieve Deposit Limits","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/balance/balancecapacity","routeSlug":"/api-reference/balance/balancecapacity","metadata":{"seo":{"title":"Retrieve Deposit Limits","description":"Returns the deposit limit for a profile based on regulatory requirements."}},"httpPath":"/profiles/{profileId}/balance-capacity","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Add an Excess Money Account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/balance/excessmoneyaccount","routeSlug":"/api-reference/balance/excessmoneyaccount","metadata":{"seo":{"title":"Add an Excess Money Account","description":"If a balance goes over the regulatory hold limit, excess funds are automatically moved to another account at the end of the day."}},"httpPath":"/profiles/{profileId}/excess-money-account","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Get Total Funds","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/balance/totalfunds","routeSlug":"/api-reference/balance/totalfunds","metadata":{"seo":{"title":"Get Total Funds","description":"Provides an overview of your account's total valuation and available liquidity across all balances."}},"httpPath":"/profiles/{profileId}/total-funds/{currency}","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"List hold limit breaches","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/balance/holdlimitbreachlist","routeSlug":"/api-reference/balance/holdlimitbreachlist","metadata":{"seo":{"title":"List hold limit breaches","description":"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)."}},"httpPath":"/profiles/{profileId}/balances/hold-limit-breach","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Close a hold limit breach","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/balance/holdlimitbreachclose","routeSlug":"/api-reference/balance/holdlimitbreachclose","metadata":{"seo":{"title":"Close a hold limit breach","description":"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."}},"httpPath":"/profiles/{profileId}/balances/hold-limit-breach/{holdLimitBreachId}","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"separator","label":"Webhooks","variant":"secondary","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Hold limit breach update","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/balance/eventholdlimitbreachupdate","routeSlug":"/api-reference/balance/eventholdlimitbreachupdate","metadata":{"seo":{"title":"Hold limit breach update","description":"Triggered whenever a hold limit breach is opened or closed for a profile. A hold limit breach occurs when a balance exceeds the regulatory hold limit (applicable in countries such as Singapore and Malaysia)."}},"httpPath":"hold-limit-breach#update","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Balance update","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/balance/eventbalancesupdate","routeSlug":"/api-reference/balance/eventbalancesupdate","metadata":{"seo":{"title":"Balance update","description":"Triggered every time a multi-currency account is credited or debited."}},"httpPath":"balances#update","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Balance account state change","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/balance/eventbalancesaccountstatechange","routeSlug":"/api-reference/balance/eventbalancesaccountstatechange","metadata":{"seo":{"title":"Balance account state change","description":"Triggered every time a balance account is activated or deactivated."}},"httpPath":"balances#account-state-change","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"}],"version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Balance Statements","link":"/api-reference/balance-statement","routeSlug":"/api-reference/balance-statement","items":[{"label":"Get Balance Statement","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/balance-statement/balancestatementget","routeSlug":"/api-reference/balance-statement/balancestatementget","metadata":{"seo":{"title":"Get Balance Statement","description":"Retrieve a statement for the specified balance account."}},"httpPath":"/profiles/{profileId}/balance-statements/{balanceId}/statement.json","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"}],"version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Bank Account Details","link":"/api-reference/bank-account-details","routeSlug":"/api-reference/bank-account-details","items":[{"type":"link","label":"Bank Account Details","link":"/api-reference/bank-account-details/bankaccountdetails","routeSlug":"/api-reference/bank-account-details/bankaccountdetails","httpVerb":"schema","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Create multiple bank account details","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/bank-account-details/bankaccountdetailsbankdetailscreate","routeSlug":"/api-reference/bank-account-details/bankaccountdetailsbankdetailscreate","metadata":{"seo":{"title":"Create multiple bank account details","description":"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."}},"httpPath":"/profiles/{profileId}/bank-details","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Retrieve bank account details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/bank-account-details/bankaccountdetailsget","routeSlug":"/api-reference/bank-account-details/bankaccountdetailsget","metadata":{"seo":{"title":"Retrieve bank account details","description":"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."}},"httpPath":"/profiles/{profileId}/account-details","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Create bank account details order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/bank-account-details/bankaccountdetailsordercreate","routeSlug":"/api-reference/bank-account-details/bankaccountdetailsordercreate","metadata":{"seo":{"title":"Create bank account details order","description":"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."}},"httpPath":"/profiles/{profileId}/account-details-orders","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"List bank account detail orders","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/bank-account-details/bankaccountdetailsorderslist","routeSlug":"/api-reference/bank-account-details/bankaccountdetailsorderslist","metadata":{"seo":{"title":"List bank account detail orders","description":"Returns the bank account assignment requests for a profile and multi-currency account."}},"httpPath":"/profiles/{profileId}/account-details-orders","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Create payment return","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/bank-account-details/bankaccountdetailsreturnscreate","routeSlug":"/api-reference/bank-account-details/bankaccountdetailsreturnscreate","metadata":{"seo":{"title":"Create payment return","description":"Creates a return for a payment received to bank account details."}},"httpPath":"/profiles/{profileId}/account-details/payments/{paymentId}/returns","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"separator","label":"Webhooks","variant":"secondary","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Account details order state change","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/bank-account-details/eventaccountdetailsorderstatechange","routeSlug":"/api-reference/bank-account-details/eventaccountdetailsorderstatechange","metadata":{"seo":{"title":"Account details order state change","description":"The event contains information about the order state and requirement state. Triggered when there is a change in the state of an account details order."}},"httpPath":"account-details-order#order-state-change","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Account details payment state change","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/bank-account-details/eventaccountdetailspaymentstatechange","routeSlug":"/api-reference/bank-account-details/eventaccountdetailspaymentstatechange","metadata":{"seo":{"title":"Account details payment state change","description":"Triggered every time a pay-in is made into the specified account details."}},"httpPath":"account-details-payment#state-change","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"}],"version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Multi Currency Account","link":"/api-reference/multi-currency-account","routeSlug":"/api-reference/multi-currency-account","items":[{"label":"Retrieve available currencies","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/multi-currency-account/mcaavailablecurrenciesget","routeSlug":"/api-reference/multi-currency-account/mcaavailablecurrenciesget","metadata":{"seo":{"title":"Retrieve available currencies","description":"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."}},"httpPath":"/borderless-accounts-configuration/profiles/{profileId}/available-currencies","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Retrieve payin currencies","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/multi-currency-account/mcapayincurrenciesget","routeSlug":"/api-reference/multi-currency-account/mcapayincurrenciesget","metadata":{"seo":{"title":"Retrieve payin currencies","description":"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."}},"httpPath":"/borderless-accounts-configuration/profiles/{profileId}/payin-currencies","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Retrieve multi currency account for a profile","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/multi-currency-account/mcaget","routeSlug":"/api-reference/multi-currency-account/mcaget","metadata":{"seo":{"title":"Retrieve multi currency account for a profile","description":"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."}},"httpPath":"/profiles/{profileId}/multi-currency-account","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Retrieve multi currency account eligibility","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/multi-currency-account/mcaeligibilityget","routeSlug":"/api-reference/multi-currency-account/mcaeligibilityget","metadata":{"seo":{"title":"Retrieve multi currency account eligibility","description":"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."}},"httpPath":"/multi-currency-account/eligibility","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"}],"version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Incoming Transfers","link":"/api-reference/incoming-transfer","routeSlug":"/api-reference/incoming-transfer","items":[{"label":"Get an incoming transfer","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/incoming-transfer/getincomingtransfer","routeSlug":"/api-reference/incoming-transfer/getincomingtransfer","metadata":{"seo":{"title":"Get an incoming transfer","description":"Retrieves an incoming transfer by id. You can pull the incoming-transfer ID from the webhook payload."}},"httpPath":"/incoming-transfers/{incomingTransferId}","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"separator","label":"Webhooks","variant":"secondary","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Incoming transfer credited","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/incoming-transfer/eventincomingtransfercredited","routeSlug":"/api-reference/incoming-transfer/eventincomingtransfercredited","metadata":{"seo":{"title":"Incoming transfer credited","description":"Triggered when an incoming transfer is credited to a Wise balance."}},"httpPath":"incoming-transfer#credited","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"}],"version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"separator","label":"Cards","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Cards","link":"/api-reference/card","routeSlug":"/api-reference/card","items":[{"type":"link","label":"Card","link":"/api-reference/card/card","routeSlug":"/api-reference/card/card","httpVerb":"schema","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"link","label":"Permission","link":"/api-reference/card/permission","routeSlug":"/api-reference/card/permission","httpVerb":"schema","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"List cards for a profile","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/card/cardlist","routeSlug":"/api-reference/card/cardlist","metadata":{"seo":{"title":"List cards for a profile","description":"Returns a paginated list of cards that belong to a specific profile."}},"httpPath":"/spend/profiles/{profileId}/cards","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Get card details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/card/cardget","routeSlug":"/api-reference/card/cardget","metadata":{"seo":{"title":"Get card details","description":"Retrieves details for a specific card by its token."}},"httpPath":"/spend/profiles/{profileId}/cards/{cardToken}","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Update card status","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/card/cardstatusupdate","routeSlug":"/api-reference/card/cardstatusupdate","metadata":{"seo":{"title":"Update card status","description":"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."}},"httpPath":"/spend/profiles/{profileId}/cards/{cardToken}/status","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Reset PIN count","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/card/cardpincountreset","routeSlug":"/api-reference/card/cardpincountreset","metadata":{"seo":{"title":"Reset PIN count","description":"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."}},"httpPath":"/spend/profiles/{profileId}/cards/{cardToken}/reset-pin-count","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Bulk update card permissions","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/card/cardpermissionsbulkupdate","routeSlug":"/api-reference/card/cardpermissionsbulkupdate","metadata":{"seo":{"title":"Bulk update card permissions","description":"Enable or disable multiple spending permissions on a card in a single request."}},"httpPath":"/spend/profiles/{profileId}/cards/{cardToken}/spending-permissions","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"separator","label":"Webhooks","variant":"secondary","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Card status change","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/card/eventcardscardstatuschange","routeSlug":"/api-reference/card/eventcardscardstatuschange","metadata":{"seo":{"title":"Card status change","description":"This event is triggered for the initial card status as well as any subsequent updates."}},"httpPath":"cards#card-status-change","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Cards manual provisioning verification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/card/eventcardsmanualprovisioningverification","routeSlug":"/api-reference/card/eventcardsmanualprovisioningverification","metadata":{"seo":{"title":"Cards manual provisioning verification","description":"Triggered when a card is manually added to a wallet provider, and the verification methods required to complete the wallet provisioning are returned."}},"httpPath":"cards#manual-provisioning-verification","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"}],"version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Sensitive Card Details","link":"/api-reference/card-sensitive-details","routeSlug":"/api-reference/card-sensitive-details","items":[{"label":"Fetch RSA encryption key","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/card-sensitive-details/cardencryptionkeyget","routeSlug":"/api-reference/card-sensitive-details/cardencryptionkeyget","metadata":{"seo":{"title":"Fetch RSA encryption key","description":"Fetches Wise's RSA public key required for encrypting sensitive card data requests."}},"httpPath":"/twcard-data/v1/clientSideEncryption/fetchEncryptingKey","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Get sensitive card details","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/card-sensitive-details/cardsensitivedetailsget","routeSlug":"/api-reference/card-sensitive-details/cardsensitivedetailsget","metadata":{"seo":{"title":"Get sensitive card details","description":"Fetches the card's Primary Account Number (PAN), security code (CVV2), expiry date, and cardholder name."}},"httpPath":"/twcard-data/v1/sensitive-card-data/details","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Get card PIN","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/card-sensitive-details/cardpinget","routeSlug":"/api-reference/card-sensitive-details/cardpinget","metadata":{"seo":{"title":"Get card PIN","description":"Fetches the card's PIN."}},"httpPath":"/twcard-data/v1/sensitive-card-data/pin","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Set card PIN","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/card-sensitive-details/cardorderpresetpin","routeSlug":"/api-reference/card-sensitive-details/cardorderpresetpin","metadata":{"seo":{"title":"Set card PIN","description":"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."}},"httpPath":"/twcard-data/v1/sensitive-card-data/preset-pin","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"}],"version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"group","label":"3D Secure Authentication","link":"/api-reference/3ds","routeSlug":"/api-reference/3ds","items":[{"label":"Inform challenge result","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/3ds/3dschallengeresultpost","routeSlug":"/api-reference/3ds/3dschallengeresultpost","metadata":{"seo":{"title":"Inform challenge result","description":"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."}},"httpPath":"/spend/profiles/{profileId}/3dsecure/challenge-result","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"separator","label":"Webhooks","variant":"secondary","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"3DS challenge","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/3ds/eventcards3dschallenge","routeSlug":"/api-reference/3ds/eventcards3dschallenge","metadata":{"seo":{"title":"3DS challenge","description":"Triggered when a customer initiates a push notification for 3DS. The provided information can be used to send a push notification to the customer's mobile app."}},"httpPath":"cards#3ds-challenge","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"}],"version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Card Kiosk Collection","link":"/api-reference/card-kiosk-collection","routeSlug":"/api-reference/card-kiosk-collection","items":[{"label":"Produce a card","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/card-kiosk-collection/cardkioskcollectionproduce","routeSlug":"/api-reference/card-kiosk-collection/cardkioskcollectionproduce","metadata":{"seo":{"title":"Produce a card","description":"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 webhook with status READY."}},"httpPath":"/spend/profiles/{profileId}/cards/{cardToken}/production","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Retrieve card production status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/card-kiosk-collection/cardkioskcollectionproductionget","routeSlug":"/api-reference/card-kiosk-collection/cardkioskcollectionproductionget","metadata":{"seo":{"title":"Retrieve card production status","description":"Retrieves the current production status of a card at a kiosk machine."}},"httpPath":"/spend/profiles/{profileId}/cards/{cardToken}/production","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"separator","label":"Webhooks","variant":"secondary","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Card production status change","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/card-kiosk-collection/eventcardscardproductionstatuschange","routeSlug":"/api-reference/card-kiosk-collection/eventcardscardproductionstatuschange","metadata":{"seo":{"title":"Card production status change","description":"Triggered every time a card production status is updated. This webhook is solely used for physical cards with KIOSK_COLLECTION delivery method."}},"httpPath":"cards#card-production-status-change","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"}],"version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Card Orders","link":"/api-reference/card-order","routeSlug":"/api-reference/card-order","items":[{"type":"link","label":"Card Order","link":"/api-reference/card-order/cardorder","routeSlug":"/api-reference/card-order/cardorder","httpVerb":"schema","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Create a card order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/card-order/cardordercreate","routeSlug":"/api-reference/card-order/cardordercreate","metadata":{"seo":{"title":"Create a card order","description":"Creates a new card order. The program field value is retrieved from the retrieve all card programs endpoint."}},"httpPath":"/spend/profiles/{profileId}/card-orders","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Retrieve all card orders","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/card-order/cardorderlist","routeSlug":"/api-reference/card-order/cardorderlist","metadata":{"seo":{"title":"Retrieve all card orders","description":"Retrieves a list of card orders created for the specified profileId."}},"httpPath":"/spend/profiles/{profileId}/card-orders","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Retrieve a card order","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/card-order/cardorderget","routeSlug":"/api-reference/card-order/cardorderget","metadata":{"seo":{"title":"Retrieve a card order","description":"Retrieves a card order based on the cardOrderId."}},"httpPath":"/spend/profiles/{profileId}/card-orders/{cardOrderId}","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Retrieve available card programs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/card-order/cardorderprogramsget","routeSlug":"/api-reference/card-order/cardorderprogramsget","metadata":{"seo":{"title":"Retrieve available card programs","description":"Retrieves the list of available card programs for each profileId."}},"httpPath":"/spend/profiles/{profileId}/card-orders/availability","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Retrieve card order requirements","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/card-order/cardorderrequirementsget","routeSlug":"/api-reference/card-order/cardorderrequirementsget","metadata":{"seo":{"title":"Retrieve card order requirements","description":"Retrieves all card requirements for a cardOrderId. A valid card order needs all its requirements status to be COMPLETED."}},"httpPath":"/spend/profiles/{profileId}/card-orders/{cardOrderId}/requirements","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Update card order status","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/card-order/cardorderstatusupdate","routeSlug":"/api-reference/card-order/cardorderstatusupdate","metadata":{"seo":{"title":"Update card order status","description":"Updates the status of a card order based on its cardOrderId. The status can be updated to one of the following:"}},"httpPath":"/spend/profiles/{profileId}/card-orders/{cardOrderId}/status","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Validate an address","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/card-order/cardordervalidateaddress","routeSlug":"/api-reference/card-order/cardordervalidateaddress","metadata":{"seo":{"title":"Validate an address","description":"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."}},"httpPath":"/spend/address/validate","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"separator","label":"Webhooks","variant":"secondary","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Card order status change","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/card-order/eventcardscardorderstatuschange","routeSlug":"/api-reference/card-order/eventcardscardorderstatuschange","metadata":{"seo":{"title":"Card order status change","description":"This event is triggered every time a card order status is updated. Statuses depend on the type of card (virtual/physical). Additional statuses related to delivery exist for physical cards."}},"httpPath":"cards#card-order-status-change","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"}],"version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Card Transactions","link":"/api-reference/card-transaction","routeSlug":"/api-reference/card-transaction","items":[{"label":"Get card transaction","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/card-transaction/cardtransactionget","routeSlug":"/api-reference/card-transaction/cardtransactionget","metadata":{"seo":{"title":"Get card transaction","description":"Retrieve a card transaction by its ID."}},"httpPath":"/spend/profiles/{profileId}/cards/transactions/{transactionId}","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"List card transactions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/card-transaction/cardtransactionlist","routeSlug":"/api-reference/card-transaction/cardtransactionlist","metadata":{"seo":{"title":"List card transactions","description":"Retrieve a list of card transactions for a specific card. Transactions are ordered by transaction ID in descending order."}},"httpPath":"/spend/profiles/{profileId}/cards/{cardToken}/transactions","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"separator","label":"Webhooks","variant":"secondary","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Card transaction state change","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/card-transaction/eventcardstransactionstatechange","routeSlug":"/api-reference/card-transaction/eventcardstransactionstatechange","metadata":{"seo":{"title":"Card transaction state change","description":"Triggered whenever a new card transaction occurs or is modified."}},"httpPath":"cards#transaction-state-change","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"}],"version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Spend Limits","link":"/api-reference/spend-limits","routeSlug":"/api-reference/spend-limits","items":[{"type":"link","label":"Profile Limits","link":"/api-reference/spend-limits/profile-limits","routeSlug":"/api-reference/spend-limits/profile-limits","httpVerb":"schema","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"link","label":"Card Limits","link":"/api-reference/spend-limits/card-limits","routeSlug":"/api-reference/spend-limits/card-limits","httpVerb":"schema","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"link","label":"Card Holder Limits","link":"/api-reference/spend-limits/card-holder-limits","routeSlug":"/api-reference/spend-limits/card-holder-limits","httpVerb":"schema","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Retrieve profile limits","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/spend-limits/spendlimitsprofileget","routeSlug":"/api-reference/spend-limits/spendlimitsprofileget","metadata":{"seo":{"title":"Retrieve profile limits","description":"Retrieves the spend limits that are configured for a profile."}},"httpPath":"/spend/profiles/{profileId}/spend-limits","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Update profile limits","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/spend-limits/spendlimitsprofileupdate","routeSlug":"/api-reference/spend-limits/spendlimitsprofileupdate","metadata":{"seo":{"title":"Update profile limits","description":"Update profile daily and monthly spend limits for PURCHASE or ATM_WITHDRAWAL. Both daily and monthly must be set."}},"httpPath":"/spend/profiles/{profileId}/spend-limits","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Retrieve card limits","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/spend-limits/spendlimitscardget","routeSlug":"/api-reference/spend-limits/spendlimitscardget","metadata":{"seo":{"title":"Retrieve card limits","description":"Retrieves the spend limits that are configured for a card."}},"httpPath":"/spend/profiles/{profileId}/cards/{cardToken}/spend-limits","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Create or update card limits","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/spend-limits/spendlimitscardupdate","routeSlug":"/api-reference/spend-limits/spendlimitscardupdate","metadata":{"seo":{"title":"Create or update card limits","description":"Create or update card transaction, daily, monthly or lifetime spend limits."}},"httpPath":"/spend/profiles/{profileId}/cards/{cardToken}/spend-limits","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Delete card limits","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/spend-limits/spendlimitscarddelete","routeSlug":"/api-reference/spend-limits/spendlimitscarddelete","metadata":{"seo":{"title":"Delete card limits","description":"Delete card spend limits for a specific granularity."}},"httpPath":"/spend/profiles/{profileId}/cards/{cardToken}/spend-limits/{granularity}","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Retrieve cardholder limits","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/spend-limits/spendlimitscardholderget","routeSlug":"/api-reference/spend-limits/spendlimitscardholderget","metadata":{"seo":{"title":"Retrieve cardholder limits","description":"Retrieves the spend limits that are configured for a cardholder. These limits apply across all cards belonging to that cardholder, not to an individual card."}},"httpPath":"/spend/profiles/{businessProfileId}/card-holder-profiles/{cardHolderProfileId}/spend-limits","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Create or update cardholder limits","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/spend-limits/spendlimitscardholderupdate","routeSlug":"/api-reference/spend-limits/spendlimitscardholderupdate","metadata":{"seo":{"title":"Create or update cardholder limits","description":"Create or update daily and monthly spend limits for a cardholder."}},"httpPath":"/spend/profiles/{businessProfileId}/card-holder-profiles/{cardHolderProfileId}/spend-limits","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Remove cardholder limits","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/spend-limits/spendlimitscardholderdelete","routeSlug":"/api-reference/spend-limits/spendlimitscardholderdelete","metadata":{"seo":{"title":"Remove cardholder limits","description":"Removes all configured spend limits for a cardholder. Both the daily and monthly windows are removed together; individual windows cannot be removed separately."}},"httpPath":"/spend/profiles/{businessProfileId}/card-holder-profiles/{cardHolderProfileId}/spend-limits","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"}],"version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Spend Controls","link":"/api-reference/spend-controls","routeSlug":"/api-reference/spend-controls","items":[{"type":"link","label":"Authorisation Rule","link":"/api-reference/spend-controls/rule","routeSlug":"/api-reference/spend-controls/rule","httpVerb":"schema","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Add a new authorisation rule","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/spend-controls/spendcontrolsrulecreate","routeSlug":"/api-reference/spend-controls/spendcontrolsrulecreate","metadata":{"seo":{"title":"Add a new authorisation rule","description":"Creates an authorisation rule. It won't be enabled unless it is applied."}},"httpPath":"/spend/applications/{clientId}/spend-controls/rules","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"List all authorisation rules","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/spend-controls/spendcontrolsruleslist","routeSlug":"/api-reference/spend-controls/spendcontrolsruleslist","metadata":{"seo":{"title":"List all authorisation rules","description":"Retrieves all the existing authorisation rules, regardless of whether or not they are applied."}},"httpPath":"/spend/applications/{clientId}/spend-controls/rules","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Apply an authorisation rule","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/spend-controls/spendcontrolsruleapply","routeSlug":"/api-reference/spend-controls/spendcontrolsruleapply","metadata":{"seo":{"title":"Apply an authorisation rule","description":"Apply an authorisation rule. This will result in the rule being evaluated against every incoming card authorisation request."}},"httpPath":"/spend/applications/{clientId}/spend-controls/rules/apply","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Unapply an authorisation rule","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/spend-controls/spendcontrolsruleunapply","routeSlug":"/api-reference/spend-controls/spendcontrolsruleunapply","metadata":{"seo":{"title":"Unapply an authorisation rule","description":"Deactivates an authorisation rule. This will result in all card transactions not being evaluated against this rule."}},"httpPath":"/spend/applications/{clientId}/spend-controls/rules/unapply","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"List applied authorisation rules","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/spend-controls/spendcontrolsappliedruleslist","routeSlug":"/api-reference/spend-controls/spendcontrolsappliedruleslist","metadata":{"seo":{"title":"List applied authorisation rules","description":"Returns the list of all the active authorisation rules that have been applied."}},"httpPath":"/spend/applications/{clientId}/spend-controls/rules/applied","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Delete an authorisation rule","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/spend-controls/spendcontrolsruledelete","routeSlug":"/api-reference/spend-controls/spendcontrolsruledelete","metadata":{"seo":{"title":"Delete an authorisation rule","description":"Deletes an authorisation rule that is currently not applied.If a rule is applied, you should unapply the rule before deleting it."}},"httpPath":"/spend/applications/{clientId}/spend-controls/rules/{ruleId}","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"}],"version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Digital Wallet","link":"/api-reference/digital-wallet","routeSlug":"/api-reference/digital-wallet","items":[{"label":"List payment tokens for a card","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/digital-wallet/pushprovisioningpaymenttokenslist","routeSlug":"/api-reference/digital-wallet/pushprovisioningpaymenttokenslist","metadata":{"seo":{"title":"List payment tokens for a card","description":"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. Note that the payment token status associated with the card may not be accurate (for example, after a phone factory reset). Therefore, it's advisable to consistently check the wallet instance for the most up-to-date token status."}},"httpPath":"/spend/profiles/{profileId}/cards/{cardToken}/payment-tokens","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Manual provisioning payment token activation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/digital-wallet/digitalwalletactivatepaymenttoken","routeSlug":"/api-reference/digital-wallet/digitalwalletactivatepaymenttoken","metadata":{"seo":{"title":"Manual provisioning payment token activation","description":"This endpoint activates the payment token for a card that has been manually added to a wallet provider. Please read this guide before implementing this API."}},"httpPath":"/spend/profiles/{profileId}/cards/{cardToken}/payment-tokens/{paymentTokenUniqueReference}/activation","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Push provisioning for Google Pay","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/digital-wallet/pushprovisioninggooglepayget","routeSlug":"/api-reference/digital-wallet/pushprovisioninggooglepayget","metadata":{"seo":{"title":"Push provisioning for Google Pay","description":"Returns encrypted cardholder information and other metadata needed for Google Pay push provisioning."}},"httpPath":"/twcard-data/v1/push-provisioning/encrypted-payload/google-pay","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Push Provisioning for Apple Pay","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/digital-wallet/pushprovisioningapplepayget","routeSlug":"/api-reference/digital-wallet/pushprovisioningapplepayget","metadata":{"seo":{"title":"Push Provisioning for Apple Pay","description":"Returns encrypted cardholder information and other metadata needed for Apple Pay push provisioning."}},"httpPath":"/twcard-data/v1/push-provisioning/encrypted-payload/apple-pay","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"}],"version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Disputes","link":"/api-reference/disputes","routeSlug":"/api-reference/disputes","items":[{"label":"Dispute dynamic flow entry point","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/disputes/disputedynamicflowstep","routeSlug":"/api-reference/disputes/disputedynamicflowstep","metadata":{"seo":{"title":"Dispute dynamic flow entry point","description":"Retrieves the JSON for initiating the dispute flow. Use this endpoint with Wise'sDynamic Flow framework."}},"httpPath":"/spend/profiles/{profileId}/dispute-form/flows/step/{scheme}/{reason}","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Retrieve dispute reasons","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/disputes/disputereasonsget","routeSlug":"/api-reference/disputes/disputereasonsget","metadata":{"seo":{"title":"Retrieve dispute reasons","description":"Retrieves the list of possible reasons for submitting a dispute."}},"httpPath":"/spend/profiles/{profileId}/dispute-form/reasons","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Submit dispute","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/disputes/disputesubmit","routeSlug":"/api-reference/disputes/disputesubmit","metadata":{"seo":{"title":"Submit dispute","description":"Submit a dispute for a card transaction."}},"httpPath":"/spend/profiles/{profileId}/dispute-form/flows/{scheme}/{reason}","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Upload dispute file","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/disputes/disputefileupload","routeSlug":"/api-reference/disputes/disputefileupload","metadata":{"seo":{"title":"Upload dispute file","description":"Upload a file for use in a dispute submission. Use the returned file ID in the files object when submitting a dispute."}},"httpPath":"/spend/profiles/{profileId}/dispute-form/file","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"List disputes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/disputes/disputelist","routeSlug":"/api-reference/disputes/disputelist","metadata":{"seo":{"title":"List disputes","description":"List disputes for a profile with optional filters."}},"httpPath":"/spend/profiles/{profileId}/disputes","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Get dispute","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/disputes/disputeget","routeSlug":"/api-reference/disputes/disputeget","metadata":{"seo":{"title":"Get dispute","description":"Retrieve a dispute by its ID."}},"httpPath":"/spend/profiles/{profileId}/disputes/{disputeId}","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Withdraw dispute","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/disputes/disputewithdraw","routeSlug":"/api-reference/disputes/disputewithdraw","metadata":{"seo":{"title":"Withdraw dispute","description":"Withdraw a dispute by setting its status to CLOSED."}},"httpPath":"/spend/profiles/{profileId}/disputes/{disputeId}/status","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"separator","label":"Webhooks","variant":"secondary","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Transaction disputes update","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/disputes/eventtransactiondisputesupdate","routeSlug":"/api-reference/disputes/eventtransactiondisputesupdate","metadata":{"seo":{"title":"Transaction disputes update","description":"Triggered every time a transaction dispute is submitted or updated."}},"httpPath":"transaction-disputes#update","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"}],"version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"separator","label":"Quotes","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Quotes","link":"/api-reference/quote","routeSlug":"/api-reference/quote","items":[{"type":"link","label":"Quote","link":"/api-reference/quote/quote","routeSlug":"/api-reference/quote/quote","httpVerb":"schema","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"link","label":"Types of quotes","link":"/api-reference/quote/types-of-quotes","routeSlug":"/api-reference/quote/types-of-quotes","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Create a quote (unauthenticated)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/quote/quotecreateunauthenticated","routeSlug":"/api-reference/quote/quotecreateunauthenticated","metadata":{"seo":{"title":"Create a quote (unauthenticated)","description":"Use this endpoint to get example quotes for illustrative purposes. This allows you to show the exchange rate and fees Wise offers before a user has created or linked an account. Often used to display a quote screen showing your customers what Wise offers before they sign up."}},"httpPath":"/quotes","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Create a quote (authenticated)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/quote/quotecreate","routeSlug":"/api-reference/quote/quotecreate","metadata":{"seo":{"title":"Create a quote (authenticated)","description":"Create an authenticated quote when the quote is to be used for a transfer."}},"httpPath":"/profiles/{profileId}/quotes","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Retrieve a quote by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/quote/quoteget","routeSlug":"/api-reference/quote/quoteget","metadata":{"seo":{"title":"Retrieve a quote by ID","description":"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."}},"httpPath":"/profiles/{profileId}/quotes/{quoteId}","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Update a quote","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/quote/quoteupdate","routeSlug":"/api-reference/quote/quoteupdate","metadata":{"seo":{"title":"Update a quote","description":"When generating a quote before a recipient, you must update the quote with the recipient sourceAccount value, as the recipient details may impact the quote properties like available payment options, price, and estimated delivery time.This is because sending some currencies to certain destinations costs a different amount based on the payment networks used (for example, it's more expensive to send USD to a country outside the USA using international payment networks, or send CAD over the Interac network)."}},"httpPath":"/profiles/{profileId}/quotes/{quoteId}","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"}],"version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Exchange Rates","link":"/api-reference/rate","routeSlug":"/api-reference/rate","items":[{"label":"Retrieve current rates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/rate/rateget","routeSlug":"/api-reference/rate/rateget","metadata":{"seo":{"title":"Retrieve current rates","description":"The from, to, and group parameters are not testable in our Sandbox environment at this time."}},"httpPath":"/rates","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"}],"version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Comparison","link":"/api-reference/comparison","routeSlug":"/api-reference/comparison","items":[{"label":"Request a comparison quote","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/comparison/comparisonget","routeSlug":"/api-reference/comparison/comparisonget","metadata":{"seo":{"title":"Request a comparison quote","description":"Request price and speed comparison data for money transfer providers on a given currency route."}},"httpPath":"/comparisons","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"}],"version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"separator","label":"Recipients","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Recipient Accounts","link":"/api-reference/recipient","routeSlug":"/api-reference/recipient","items":[{"type":"link","label":"Recipient Account","link":"/api-reference/recipient/recipient","routeSlug":"/api-reference/recipient/recipient","httpVerb":"schema","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"List recipient accounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/recipient/recipientlist","routeSlug":"/api-reference/recipient/recipientlist","metadata":{"seo":{"title":"List recipient accounts","description":"Fetches a list of the user's recipient accounts."}},"httpPath":"/accounts","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Create a recipient account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/recipient/recipientcreate","routeSlug":"/api-reference/recipient/recipientcreate","metadata":{"seo":{"title":"Create a recipient account","description":"Creates a recipient account. A recipient is the person or institution who is the ultimate beneficiary of your payment."}},"httpPath":"/accounts","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Get account by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/recipient/recipientget","routeSlug":"/api-reference/recipient/recipientget","metadata":{"seo":{"title":"Get account by ID","description":"Get recipient account info by ID."}},"httpPath":"/accounts/{accountId}","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Deactivate a recipient account","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/recipient/recipientdeactivate","routeSlug":"/api-reference/recipient/recipientdeactivate","metadata":{"seo":{"title":"Deactivate a recipient account","description":"Deletes a recipient by changing its status to inactive (\"active\": false)."}},"httpPath":"/accounts/{accountId}","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Retrieve recipient account requirements dynamically","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/recipient/recipientaccountrequirementsget","routeSlug":"/api-reference/recipient/recipientaccountrequirementsget","metadata":{"seo":{"title":"Retrieve recipient account requirements dynamically","description":"The details required to create a recipient account vary by currency, type, and receiving entity. To determine which fields are required to successfully create a specific recipient, send a request to this endpoint. The response returns an array of objects that indicate which recipient account types are available for the corridor, as well as the fields and related attributes that apply to the currency and account type."}},"httpPath":"/quotes/{quoteId}/account-requirements","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Retrieve additional recipient account requirements dynamically","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/recipient/recipientaccountrequirementspost","routeSlug":"/api-reference/recipient/recipientaccountrequirementspost","metadata":{"seo":{"title":"Retrieve additional recipient account requirements dynamically","description":"If refreshRequirementsOnChange=true for any group.key in the GET response, send this POST request with the updated create recipient account request payload. The response returns the additional required fields for that key based on the updated key value."}},"httpPath":"/quotes/{quoteId}/account-requirements","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Check account and quote compatibility","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/recipient/recipientcompatibilitycheck","routeSlug":"/api-reference/recipient/recipientcompatibilitycheck","metadata":{"seo":{"title":"Check account and quote compatibility","description":"Use this endpoint to check the compatibility of a recipient account with a quote before creating a transfer. This validation includes:"}},"httpPath":"/accounts/{accountId}/quotes/{quoteId}/compatibility","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Accept confirmation outcomes","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/recipient/recipientconfirmationsaccept","routeSlug":"/api-reference/recipient/recipientconfirmationsaccept","metadata":{"seo":{"title":"Accept confirmation outcomes","description":"When the confirmation outcome indicates requiresCustomerAcceptance is true, the recipient cannot be used for a transfer until the customer explicitly confirms the details. Present the mismatch to the customer and get their approval before proceeding further into the transfer flow."}},"httpPath":"/accounts/{accountId}/confirmations","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"separator","label":"Webhooks","variant":"secondary","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Recipient state change","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/recipient/eventrecipientsstatechange","routeSlug":"/api-reference/recipient/eventrecipientsstatechange","metadata":{"seo":{"title":"Recipient state change","description":"Triggered when a recipient account created or changed through hosted recipient creation changes state.See the Embedded Flows guide for an example recipient creation flow."}},"httpPath":"recipients#state-change","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"}],"version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Contacts","link":"/api-reference/contact","routeSlug":"/api-reference/contact","items":[{"label":"Create a contact from an identifier","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/contact/contactcreate","routeSlug":"/api-reference/contact/contactcreate","metadata":{"seo":{"title":"Create a contact from an identifier","description":"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."}},"httpPath":"/profiles/{profileId}/contacts","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"}],"version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"separator","label":"Transfers","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Transfers","link":"/api-reference/transfer","routeSlug":"/api-reference/transfer","items":[{"type":"link","label":"Standard Transfer","link":"/api-reference/transfer/transfer","routeSlug":"/api-reference/transfer/transfer","httpVerb":"schema","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"link","label":"Originator Transfer","link":"/api-reference/transfer/originator-transfer","routeSlug":"/api-reference/transfer/originator-transfer","httpVerb":"schema","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Get a transfer by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/transfer/transferget","routeSlug":"/api-reference/transfer/transferget","metadata":{"seo":{"title":"Get a transfer by ID","description":"Get transfer info by ID. To receive dynamic updates as the state of the transfer changes, see the webhooks documentation."}},"httpPath":"/transfers/{transferId}","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Cancel a transfer","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/transfer/transfercancel","routeSlug":"/api-reference/transfer/transfercancel","metadata":{"seo":{"title":"Cancel a transfer","description":"Transfers may be cancelled up until the transfer has been processed and funds converted. Cancellation is final — it cannot be undone."}},"httpPath":"/transfers/{transferId}/cancel","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Validate transfer requirements","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/transfer/transferrequirementsvalidate","routeSlug":"/api-reference/transfer/transferrequirementsvalidate","metadata":{"seo":{"title":"Validate transfer requirements","description":"Exposes transfer-specific requirements based on the sender, quote, and target recipient account. Requirements vary by currency route, transfer amount, and regulatory region."}},"httpPath":"/transfer-requirements","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Fund a Transfer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/transfer/transferfund","routeSlug":"/api-reference/transfer/transferfund","metadata":{"seo":{"title":"Fund a Transfer","description":"This endpoint is SCA protected when it applies. If your profile is registered within the UK and/or EEA, SCA most likely applies to you.Please read more about implementing SCA."}},"httpPath":"/profiles/{profileId}/transfers/{transferId}/payments","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"List completed payments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/transfer/transferpaymentslist","routeSlug":"/api-reference/transfer/transferpaymentslist","metadata":{"seo":{"title":"List completed payments","description":"Fetch completed payments used to fund the transfer."}},"httpPath":"/transfers/{transferId}/payments","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Get payout information","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/transfer/transferpayoutinfoget","routeSlug":"/api-reference/transfer/transferpayoutinfoget","metadata":{"seo":{"title":"Get payout information","description":"Fetch banking reference information for transfers that are in outgoing_payment_sent status, enabling you to track transfers with the transfer recipient's bank."}},"httpPath":"/transfers/{transferId}/invoices/bankingpartner","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Get a transfer receipt","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/transfer/transferreceiptget","routeSlug":"/api-reference/transfer/transferreceiptget","metadata":{"seo":{"title":"Get a transfer receipt","description":"Download transfer confirmation receipt in PDF format for transfers that are in status outgoing_payment_sent.There's also the transfer state change webhook."}},"httpPath":"/transfers/{transferId}/receipt.pdf","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Get a US combined disclosure receipt","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/transfer/transferuscombinedreceiptget","routeSlug":"/api-reference/transfer/transferuscombinedreceiptget","metadata":{"seo":{"title":"Get a US combined disclosure receipt","description":"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."}},"httpPath":"/transfers/{transferId}/us-combined-receipt.pdf","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Get a non objection certificate (INR)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/transfer/transfernocget","routeSlug":"/api-reference/transfer/transfernocget","metadata":{"seo":{"title":"Get a non objection certificate (INR)","description":"Download transfer non objection certificate in PDF format for transfers that are in status outgoing_payment_sent."}},"httpPath":"/transfers/{transferId}/documents/noc","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"separator","label":"Webhooks","variant":"secondary","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Transfer active cases","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/transfer/eventtransfersactivecases","routeSlug":"/api-reference/transfer/eventtransfersactivecases","metadata":{"seo":{"title":"Transfer active cases","description":"Triggered every time a transfer's list of active cases is updated.Active cases indicate potential problems with transfer processing."}},"httpPath":"transfers#active-cases","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Transfer refund","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/transfer/eventtransfersrefund","routeSlug":"/api-reference/transfer/eventtransfersrefund","metadata":{"seo":{"title":"Transfer refund","description":"This event provides information about refund amount and currency. Triggered every time a transfer's status becomes funds_refunded."}},"httpPath":"transfers#refund","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Transfer payout failure","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/transfer/eventtransferspayoutfailure","routeSlug":"/api-reference/transfer/eventtransferspayoutfailure","metadata":{"seo":{"title":"Transfer payout failure","description":"Triggered every time a payout fails. Use this event to get further information about a failed payment."}},"httpPath":"transfers#payout-failure","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Transfer state change","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/transfer/eventtransfersstatechange","routeSlug":"/api-reference/transfer/eventtransfersstatechange","metadata":{"seo":{"title":"Transfer state change","description":"Triggered every time a transfer's status is updated."}},"httpPath":"transfers#state-change","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"}],"version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Standard Transfers","link":"/api-reference/standard-transfer","routeSlug":"/api-reference/standard-transfer","items":[{"label":"Create a transfer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/standard-transfer/transfercreate","routeSlug":"/api-reference/standard-transfer/transfercreate","metadata":{"seo":{"title":"Create a transfer","description":"Create a transfer to a recipient account based on a quote."}},"httpPath":"/transfers","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"List transfers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/standard-transfer/transferlist","routeSlug":"/api-reference/standard-transfer/transferlist","metadata":{"seo":{"title":"List transfers","description":"Get the list of transfers for a given user's profile (defaults to user's personal profile)."}},"httpPath":"/transfers","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"}],"version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Third Party Transfers","link":"/api-reference/third-party-transfer","routeSlug":"/api-reference/third-party-transfer","items":[{"label":"Create a third party transfer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/third-party-transfer/createthirdpartytransfer","routeSlug":"/api-reference/third-party-transfer/createthirdpartytransfer","metadata":{"seo":{"title":"Create a third party transfer","description":"When creating a transfer on behalf of a third party, you must take note that:"}},"httpPath":"/profiles/{profileId}/third-party-transfers","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Get a third party transfer by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/third-party-transfer/getthirdpartytransfer","routeSlug":"/api-reference/third-party-transfer/getthirdpartytransfer","metadata":{"seo":{"title":"Get a third party transfer by ID","description":"Get third party transfer info by ID. To receive dynamic updates as the state of the transfer changes, see the webhooks documentation."}},"httpPath":"/profiles/{profileId}/third-party-transfers/{transferId}","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"}],"version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Delivery Estimate","link":"/api-reference/delivery-estimate","routeSlug":"/api-reference/delivery-estimate","items":[{"label":"Get the delivery estimate for a transfer","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/delivery-estimate/deliveryestimateget","routeSlug":"/api-reference/delivery-estimate/deliveryestimateget","metadata":{"seo":{"title":"Get the delivery estimate for a transfer","description":"Get the live delivery estimate for a transfer by the transfer ID."}},"httpPath":"/delivery-estimates/{transferId}","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"}],"version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Currencies","link":"/api-reference/currencies","routeSlug":"/api-reference/currencies","items":[{"label":"Get all currencies allowed for transfers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/currencies/currenciesget","routeSlug":"/api-reference/currencies/currenciesget","metadata":{"seo":{"title":"Get all currencies allowed for transfers","description":"Returns all currencies available for creating transfers. Currency names are returned in English by default — pass an Accept-Language header to receive localized names."}},"httpPath":"/currencies","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"}],"version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Batch Payment Groups","link":"/api-reference/batch-group","routeSlug":"/api-reference/batch-group","items":[{"type":"link","label":"Batch Group","link":"/api-reference/batch-group/batchgroup","routeSlug":"/api-reference/batch-group/batchgroup","httpVerb":"schema","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Create a batch group","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/batch-group/batchgroupcreate","routeSlug":"/api-reference/batch-group/batchgroupcreate","metadata":{"seo":{"title":"Create a batch group","description":"Create a new batch group."}},"httpPath":"/profiles/{profileId}/batch-groups","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Retrieve a batch group","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/batch-group/batchgroupget","routeSlug":"/api-reference/batch-group/batchgroupget","metadata":{"seo":{"title":"Retrieve a batch group","description":"Get an existing batch group by ID."}},"httpPath":"/profiles/{profileId}/batch-groups/{batchGroupId}","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Update batch group status","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/batch-group/batchgroupupdate","routeSlug":"/api-reference/batch-group/batchgroupupdate","metadata":{"seo":{"title":"Update batch group status","description":"Update a batch group's status to complete or cancel it."}},"httpPath":"/profiles/{profileId}/batch-groups/{batchGroupId}","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Create a batch group transfer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/batch-group/batchgrouptransfercreate","routeSlug":"/api-reference/batch-group/batchgrouptransfercreate","metadata":{"seo":{"title":"Create a batch group transfer","description":"Create a transfer in the batch group using a previously created recipient account and quote."}},"httpPath":"/profiles/{profileId}/batch-groups/{batchGroupId}/transfers","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Fund a batch group","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/batch-group/batchgroupfund","routeSlug":"/api-reference/batch-group/batchgroupfund","metadata":{"seo":{"title":"Fund a batch group","description":"Funds all transfers in a batch group from a multi-currency account balance. Transfers are paid out immediately."}},"httpPath":"/profiles/{profileId}/batch-payments/{batchGroupId}/payments","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Fund a batch group via direct debit","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/batch-group/batchgrouppaymentinitiationcreate","routeSlug":"/api-reference/batch-group/batchgrouppaymentinitiationcreate","metadata":{"seo":{"title":"Fund a batch group via direct debit","description":"Funds all transfers in a batch group via direct debit. The batch group must be in the COMPLETED state."}},"httpPath":"/profiles/{profileId}/batch-groups/{batchGroupId}/payment-initiations","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Retrieve a payment initiation","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/batch-group/batchgrouppaymentinitiationget","routeSlug":"/api-reference/batch-group/batchgrouppaymentinitiationget","metadata":{"seo":{"title":"Retrieve a payment initiation","description":"Get payment initiation info by ID. In addition to webhooks, this endpoint can be used for polling the status of a payment initiation."}},"httpPath":"/profiles/{profileId}/batch-groups/{batchGroupId}/payment-initiations/{paymentInitiationId}","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"separator","label":"Webhooks","variant":"secondary","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Batch payment initiations state change","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/batch-group/eventbatchpaymentinitiationsstatechange","routeSlug":"/api-reference/batch-group/eventbatchpaymentinitiationsstatechange","metadata":{"seo":{"title":"Batch payment initiations state change","description":"Triggered when the payment initiation state of a batch group payment changes."}},"httpPath":"batch-payment-initiations#state-change","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"}],"version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"separator","label":"Funding","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Payin Deposit Detail","link":"/api-reference/payin-deposit-detail","routeSlug":"/api-reference/payin-deposit-detail","items":[{"label":"Retrieve bank transfer deposit details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/payin-deposit-detail/payindepositdetailget","routeSlug":"/api-reference/payin-deposit-detail/payindepositdetailget","metadata":{"seo":{"title":"Retrieve bank transfer deposit details","description":"Retrieve the bank details for the account that the customer should send funds to when paying for a Wise transfer via a bank transfer."}},"httpPath":"/profiles/{profileId}/transfers/{transferId}/deposit-details/bank-transfer","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"}],"version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Direct Debit Account","link":"/api-reference/direct-debit-account","routeSlug":"/api-reference/direct-debit-account","items":[{"label":"Create a direct debit account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/direct-debit-account/directdebitaccountcreate","routeSlug":"/api-reference/direct-debit-account/directdebitaccountcreate","metadata":{"seo":{"title":"Create a direct debit account","description":"Register a new external bank account for funding batch transfers via direct debit."}},"httpPath":"/profiles/{profileId}/direct-debit-accounts","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Retrieve all direct debit accounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/direct-debit-account/directdebitaccountget","routeSlug":"/api-reference/direct-debit-account/directdebitaccountget","metadata":{"seo":{"title":"Retrieve all direct debit accounts","description":"Get a list of your direct debit accounts. Use the type and currency query parameters to filter accounts."}},"httpPath":"/profiles/{profileId}/direct-debit-accounts","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"}],"version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Bulk Settlement","link":"/api-reference/bulk-settlement","routeSlug":"/api-reference/bulk-settlement","items":[{"label":"Send a settlement journal","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/bulk-settlement/bulksettlementjournalcreate","routeSlug":"/api-reference/bulk-settlement/bulksettlementjournalcreate","metadata":{"seo":{"title":"Send a settlement journal","description":"Sends the settlement journal to Wise. There are two types of settlement:"}},"httpPath":"/settlements","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"separator","label":"Webhooks","variant":"secondary","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Bulk settlement payment received","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/bulk-settlement/eventbulksettlementpaymentreceived","routeSlug":"/api-reference/bulk-settlement/eventbulksettlementpaymentreceived","metadata":{"seo":{"title":"Bulk settlement payment received","description":"Triggered when a bulk settlement fund is received. Once there is a match, meaning the amount for this settlement journal is fully settled, the amount_matched is set to true. If it is not matched, check the difference between source_amount and target_amount to determine how much more needs to be paid."}},"httpPath":"bulk-settlement#payment-received","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"}],"version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Payins","link":"/api-reference/payins","routeSlug":"/api-reference/payins","items":[{"label":"Create PayNow payment details","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/payins/paynowcreate","routeSlug":"/api-reference/payins/paynowcreate","metadata":{"seo":{"title":"Create PayNow payment details","description":"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. This operation supports the SGD currency only."}},"httpPath":"/profiles/{profileId}/payin-sessions/{payinSessionId}/paynow","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"}],"version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"separator","label":"Webhooks","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Subscriptions","link":"/api-reference/webhook","routeSlug":"/api-reference/webhook","items":[{"label":"Create Application Webhook Subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/webhook/webhookapplicationsubscriptioncreate","routeSlug":"/api-reference/webhook/webhookapplicationsubscriptioncreate","metadata":{"seo":{"title":"Create Application Webhook Subscription","description":"Create a webhook subscription at the application level."}},"httpPath":"/applications/{clientKey}/subscriptions","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"List Application Webhook Subscriptions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/webhook/webhookapplicationsubscriptionlist","routeSlug":"/api-reference/webhook/webhookapplicationsubscriptionlist","metadata":{"seo":{"title":"List Application Webhook Subscriptions","description":"List all webhook subscriptions for your application."}},"httpPath":"/applications/{clientKey}/subscriptions","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Get Application Webhook Subscription","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/webhook/webhookapplicationsubscriptionget","routeSlug":"/api-reference/webhook/webhookapplicationsubscriptionget","metadata":{"seo":{"title":"Get Application Webhook Subscription","description":"Retrieve an application webhook subscription by its identifier."}},"httpPath":"/applications/{clientKey}/subscriptions/{subscriptionId}","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Delete Application Webhook Subscription","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/webhook/webhookapplicationsubscriptiondelete","routeSlug":"/api-reference/webhook/webhookapplicationsubscriptiondelete","metadata":{"seo":{"title":"Delete Application Webhook Subscription","description":"Delete an application webhook subscription by its identifier."}},"httpPath":"/applications/{clientKey}/subscriptions/{subscriptionId}","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Test Application Webhook Subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/webhook/webhookapplicationsubscriptiontest","routeSlug":"/api-reference/webhook/webhookapplicationsubscriptiontest","metadata":{"seo":{"title":"Test Application Webhook Subscription","description":"Generate test notifications for an existing application subscription."}},"httpPath":"/applications/{clientKey}/subscriptions/{subscriptionId}/test-notifications","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Create Profile Webhook Subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/webhook/webhookprofilesubscriptioncreate","routeSlug":"/api-reference/webhook/webhookprofilesubscriptioncreate","metadata":{"seo":{"title":"Create Profile Webhook Subscription","description":"Create a webhook subscription at the profile level."}},"httpPath":"/profiles/{profileId}/subscriptions","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"List Profile Webhook Subscriptions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/webhook/webhookprofilesubscriptionlist","routeSlug":"/api-reference/webhook/webhookprofilesubscriptionlist","metadata":{"seo":{"title":"List Profile Webhook Subscriptions","description":"List all webhook subscriptions for a profile."}},"httpPath":"/profiles/{profileId}/subscriptions","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Get Profile Webhook Subscription","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/webhook/webhookprofilesubscriptionget","routeSlug":"/api-reference/webhook/webhookprofilesubscriptionget","metadata":{"seo":{"title":"Get Profile Webhook Subscription","description":"Retrieve a profile webhook subscription by its identifier."}},"httpPath":"/profiles/{profileId}/subscriptions/{subscriptionId}","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Delete Profile Webhook Subscription","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/webhook/webhookprofilesubscriptiondelete","routeSlug":"/api-reference/webhook/webhookprofilesubscriptiondelete","metadata":{"seo":{"title":"Delete Profile Webhook Subscription","description":"Delete a profile webhook subscription by its identifier."}},"httpPath":"/profiles/{profileId}/subscriptions/{subscriptionId}","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"}],"version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Events","link":"/api-reference/webhook-event","routeSlug":"/api-reference/webhook-event","items":[{"label":"Transfer active cases","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/webhook-event/eventtransfersactivecases","routeSlug":"/api-reference/webhook-event/eventtransfersactivecases","metadata":{"seo":{"title":"Transfer active cases","description":"Triggered every time a transfer's list of active cases is updated.Active cases indicate potential problems with transfer processing."}},"httpPath":"transfers#active-cases","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Transfer refund","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/webhook-event/eventtransfersrefund","routeSlug":"/api-reference/webhook-event/eventtransfersrefund","metadata":{"seo":{"title":"Transfer refund","description":"This event provides information about refund amount and currency. Triggered every time a transfer's status becomes funds_refunded."}},"httpPath":"transfers#refund","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Transfer payout failure","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/webhook-event/eventtransferspayoutfailure","routeSlug":"/api-reference/webhook-event/eventtransferspayoutfailure","metadata":{"seo":{"title":"Transfer payout failure","description":"Triggered every time a payout fails. Use this event to get further information about a failed payment."}},"httpPath":"transfers#payout-failure","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Transfer state change","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/webhook-event/eventtransfersstatechange","routeSlug":"/api-reference/webhook-event/eventtransfersstatechange","metadata":{"seo":{"title":"Transfer state change","description":"Triggered every time a transfer's status is updated."}},"httpPath":"transfers#state-change","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Account details order state change","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/webhook-event/eventaccountdetailsorderstatechange","routeSlug":"/api-reference/webhook-event/eventaccountdetailsorderstatechange","metadata":{"seo":{"title":"Account details order state change","description":"The event contains information about the order state and requirement state. Triggered when there is a change in the state of an account details order."}},"httpPath":"account-details-order#order-state-change","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Account details payment state change","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/webhook-event/eventaccountdetailspaymentstatechange","routeSlug":"/api-reference/webhook-event/eventaccountdetailspaymentstatechange","metadata":{"seo":{"title":"Account details payment state change","description":"Triggered every time a pay-in is made into the specified account details."}},"httpPath":"account-details-payment#state-change","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Card status change","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/webhook-event/eventcardscardstatuschange","routeSlug":"/api-reference/webhook-event/eventcardscardstatuschange","metadata":{"seo":{"title":"Card status change","description":"This event is triggered for the initial card status as well as any subsequent updates."}},"httpPath":"cards#card-status-change","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Card production status change","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/webhook-event/eventcardscardproductionstatuschange","routeSlug":"/api-reference/webhook-event/eventcardscardproductionstatuschange","metadata":{"seo":{"title":"Card production status change","description":"Triggered every time a card production status is updated. This webhook is solely used for physical cards with KIOSK_COLLECTION delivery method."}},"httpPath":"cards#card-production-status-change","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"3DS challenge","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/webhook-event/eventcards3dschallenge","routeSlug":"/api-reference/webhook-event/eventcards3dschallenge","metadata":{"seo":{"title":"3DS challenge","description":"Triggered when a customer initiates a push notification for 3DS. The provided information can be used to send a push notification to the customer's mobile app."}},"httpPath":"cards#3ds-challenge","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Card order status change","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/webhook-event/eventcardscardorderstatuschange","routeSlug":"/api-reference/webhook-event/eventcardscardorderstatuschange","metadata":{"seo":{"title":"Card order status change","description":"This event is triggered every time a card order status is updated. Statuses depend on the type of card (virtual/physical). Additional statuses related to delivery exist for physical cards."}},"httpPath":"cards#card-order-status-change","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Card transaction state change","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/webhook-event/eventcardstransactionstatechange","routeSlug":"/api-reference/webhook-event/eventcardstransactionstatechange","metadata":{"seo":{"title":"Card transaction state change","description":"Triggered whenever a new card transaction occurs or is modified."}},"httpPath":"cards#transaction-state-change","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Cards manual provisioning verification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/webhook-event/eventcardsmanualprovisioningverification","routeSlug":"/api-reference/webhook-event/eventcardsmanualprovisioningverification","metadata":{"seo":{"title":"Cards manual provisioning verification","description":"Triggered when a card is manually added to a wallet provider, and the verification methods required to complete the wallet provisioning are returned."}},"httpPath":"cards#manual-provisioning-verification","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Hold limit breach update","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/webhook-event/eventholdlimitbreachupdate","routeSlug":"/api-reference/webhook-event/eventholdlimitbreachupdate","metadata":{"seo":{"title":"Hold limit breach update","description":"Triggered whenever a hold limit breach is opened or closed for a profile. A hold limit breach occurs when a balance exceeds the regulatory hold limit (applicable in countries such as Singapore and Malaysia)."}},"httpPath":"hold-limit-breach#update","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Additional verification state change","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/webhook-event/eventprofilescddcheckstatechange","routeSlug":"/api-reference/webhook-event/eventprofilescddcheckstatechange","metadata":{"seo":{"title":"Additional verification state change","description":"This event pushes updates for the Additional Customer Verification process."}},"httpPath":"profiles#cdd-check-state-change","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Overdraft limit threshold","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/webhook-event/eventprofilesoverdraftlimitthreshold","routeSlug":"/api-reference/webhook-event/eventprofilesoverdraftlimitthreshold","metadata":{"seo":{"title":"Overdraft limit threshold","description":"Triggered when the overdraft limit usage has reached 70% threshold. The event at each threshold is triggered maximum once per hour."}},"httpPath":"profiles#overdraft-limit-threshold","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Profile state change","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/webhook-event/eventprofilesstatechange","routeSlug":"/api-reference/webhook-event/eventprofilesstatechange","metadata":{"seo":{"title":"Profile state change","description":"Triggered every time a profile's state is updated."}},"httpPath":"profiles#state-change","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Verification state change","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/webhook-event/eventprofilesverificationstatechange","routeSlug":"/api-reference/webhook-event/eventprofilesverificationstatechange","metadata":{"seo":{"title":"Verification state change","description":"Triggered when the verification state of a connected profile changes."}},"httpPath":"profiles#verification-state-change","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"KYC review state change","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/webhook-event/eventkycreviewsstatechange","routeSlug":"/api-reference/webhook-event/eventkycreviewsstatechange","metadata":{"seo":{"title":"KYC review state change","description":"Triggered when a KYC review state has changed."}},"httpPath":"kyc-reviews#state-change","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"User state change","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/webhook-event/eventusersstatechange","routeSlug":"/api-reference/webhook-event/eventusersstatechange","metadata":{"seo":{"title":"User state change","description":"Triggered every time a user's state is updated."}},"httpPath":"users#state-change","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Balance update","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/webhook-event/eventbalancesupdate","routeSlug":"/api-reference/webhook-event/eventbalancesupdate","metadata":{"seo":{"title":"Balance update","description":"Triggered every time a multi-currency account is credited or debited."}},"httpPath":"balances#update","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Balance account state change","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/webhook-event/eventbalancesaccountstatechange","routeSlug":"/api-reference/webhook-event/eventbalancesaccountstatechange","metadata":{"seo":{"title":"Balance account state change","description":"Triggered every time a balance account is activated or deactivated."}},"httpPath":"balances#account-state-change","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Batch payment initiations state change","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/webhook-event/eventbatchpaymentinitiationsstatechange","routeSlug":"/api-reference/webhook-event/eventbatchpaymentinitiationsstatechange","metadata":{"seo":{"title":"Batch payment initiations state change","description":"Triggered when the payment initiation state of a batch group payment changes."}},"httpPath":"batch-payment-initiations#state-change","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Partner support case changed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/webhook-event/eventpartnersupportcasechanged","routeSlug":"/api-reference/webhook-event/eventpartnersupportcasechanged","metadata":{"seo":{"title":"Partner support case changed","description":"Triggered every time a case is created or updated, including when a new message is added or the status changes.Note that you will also receive a webhook response when you have updated a case."}},"httpPath":"partner-support#case-changed","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Swift receive credit","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/webhook-event/eventswiftincredit","routeSlug":"/api-reference/webhook-event/eventswiftincredit","metadata":{"seo":{"title":"Swift receive credit","description":"Triggered every time a SWIFT message is received and a credit is deposited into a balance account."}},"httpPath":"swift-in#credit","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Swift message received","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/webhook-event/eventswiftmessagereceived","routeSlug":"/api-reference/webhook-event/eventswiftmessagereceived","metadata":{"seo":{"title":"Swift message received","description":"Triggered when a SWIFT message (e.g., pacs.008) is received and processed by Wise on behalf of a partner."}},"httpPath":"swift#message-received","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Transaction disputes update","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/webhook-event/eventtransactiondisputesupdate","routeSlug":"/api-reference/webhook-event/eventtransactiondisputesupdate","metadata":{"seo":{"title":"Transaction disputes update","description":"Triggered every time a transaction dispute is submitted or updated."}},"httpPath":"transaction-disputes#update","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Bulk settlement payment received","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/webhook-event/eventbulksettlementpaymentreceived","routeSlug":"/api-reference/webhook-event/eventbulksettlementpaymentreceived","metadata":{"seo":{"title":"Bulk settlement payment received","description":"Triggered when a bulk settlement fund is received. Once there is a match, meaning the amount for this settlement journal is fully settled, the amount_matched is set to true. If it is not matched, check the difference between source_amount and target_amount to determine how much more needs to be paid."}},"httpPath":"bulk-settlement#payment-received","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Incoming transfer credited","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/webhook-event/eventincomingtransfercredited","routeSlug":"/api-reference/webhook-event/eventincomingtransfercredited","metadata":{"seo":{"title":"Incoming transfer credited","description":"Triggered when an incoming transfer is credited to a Wise balance."}},"httpPath":"incoming-transfer#credited","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Recipient state change","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/webhook-event/eventrecipientsstatechange","routeSlug":"/api-reference/webhook-event/eventrecipientsstatechange","metadata":{"seo":{"title":"Recipient state change","description":"Triggered when a recipient account created or changed through hosted recipient creation changes state.See the Embedded Flows guide for an example recipient creation flow."}},"httpPath":"recipients#state-change","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"}],"version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"separator","label":"Simulations","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Simulations","link":"/api-reference/simulation","routeSlug":"/api-reference/simulation","items":[{"label":"Simulate transfer state change","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/simulation/simulationtransferstatechange","routeSlug":"/api-reference/simulation/simulationtransferstatechange","metadata":{"seo":{"title":"Simulate transfer state change","description":"Changes the transfer status to the specified state. The available state transitions are:"}},"httpPath":"/simulation/transfers/{transferId}/{status}","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Simulate transfer payout failure","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/simulation/simulationtransferpayoutfailure","routeSlug":"/api-reference/simulation/simulationtransferpayoutfailure","metadata":{"seo":{"title":"Simulate transfer payout failure","description":"Triggers transfers#payout-failure webhook for the transfer."}},"httpPath":"/simulation/transfers/{transferId}/payout-failure","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Simulate verification for a profile","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/simulation/simulationverification","routeSlug":"/api-reference/simulation/simulationverification","metadata":{"seo":{"title":"Simulate verification for a profile","description":"Changes a specific profile's verification state to PASSED."}},"httpPath":"/simulation/profiles/{profileId}/verifications","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Simulate verification for all profiles","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/simulation/simulationverifyprofile","routeSlug":"/api-reference/simulation/simulationverifyprofile","metadata":{"seo":{"title":"Simulate verification for all profiles","description":"Verifies all profiles associated with the authenticated user, changing their verification state to PASSED."}},"httpPath":"/simulation/verify-profile","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Simulate a balance top-up","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/simulation/simulationbalancetopup","routeSlug":"/api-reference/simulation/simulationbalancetopup","metadata":{"seo":{"title":"Simulate a balance top-up","description":"Simulates a top-up so that a balance can be used to fund transfers and/or card spend."}},"httpPath":"/simulation/balance/topup","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Simulate a card transaction authorisation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/simulation/simulationcardtransactionauthorisation","routeSlug":"/api-reference/simulation/simulationcardtransactionauthorisation","metadata":{"seo":{"title":"Simulate a card transaction authorisation","description":"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."}},"httpPath":"/simulation/spend/profiles/{profileId}/cards/{cardToken}/transactions/authorisation","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Simulate a card transaction clearing","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/simulation/simulationcardtransactionclearing","routeSlug":"/api-reference/simulation/simulationcardtransactionclearing","metadata":{"seo":{"title":"Simulate a card transaction clearing","description":"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."}},"httpPath":"/simulation/spend/profiles/{profileId}/cards/{cardToken}/transactions/clearing","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Simulate a card transaction reversal","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/simulation/simulationcardtransactionreversal","routeSlug":"/api-reference/simulation/simulationcardtransactionreversal","metadata":{"seo":{"title":"Simulate a card transaction reversal","description":"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."}},"httpPath":"/simulation/spend/profiles/{profileId}/cards/{cardToken}/transactions/reversal","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"List simulated card transactions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/simulation/simulationcardtransactions","routeSlug":"/api-reference/simulation/simulationcardtransactions","metadata":{"seo":{"title":"List simulated card transactions","description":"Returns a list of simulated card transactions, in descending order of creation time."}},"httpPath":"/simulation/spend/profiles/{profileId}/cards/{cardToken}/transactions","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Simulate card production state change","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/simulation/simulationcardproduction","routeSlug":"/api-reference/simulation/simulationcardproduction","metadata":{"seo":{"title":"Simulate card production state change","description":"Simulates a card production status change in the sandbox environment."}},"httpPath":"/simulation/spend/profiles/{profileId}/cards/{cardToken}/production","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"List KYC review requirements","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/simulation/simulationkycreviewrequirementslist","routeSlug":"/api-reference/simulation/simulationkycreviewrequirementslist","metadata":{"seo":{"title":"List KYC review requirements","description":"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."}},"httpPath":"/simulation/profiles/{profileId}/kyc-reviews/{kycReviewId}/requirements","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Simulate adding new requirement","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/simulation/simulationkycreviewrequirementsadd","routeSlug":"/api-reference/simulation/simulationkycreviewrequirementsadd","metadata":{"seo":{"title":"Simulate adding new requirement","description":"Creates a new requirement for a KYC (Know Your Customer) review for a business profile."}},"httpPath":"/simulation/profiles/{profileId}/kyc-reviews/{kycReviewId}/requirements/add","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Simulate requirement submission","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/simulation/simulationkycreviewrequirementssubmit","routeSlug":"/api-reference/simulation/simulationkycreviewrequirementssubmit","metadata":{"seo":{"title":"Simulate requirement submission","description":"Simulates providing everything needed for a particular KYC requirement. This can be used in place of going through a hosted journey on the browser."}},"httpPath":"/simulation/profiles/{profileId}/kyc-reviews/{kycReviewId}/requirements/submit","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Simulate verifying a KYC review","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/simulation/simulationkycreviewverify","routeSlug":"/api-reference/simulation/simulationkycreviewverify","metadata":{"seo":{"title":"Simulate verifying a KYC review","description":"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."}},"httpPath":"/simulation/profiles/{profileId}/kyc-reviews/{kycReviewId}/verify","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Simulate incoming bank transfer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/simulation/simulationbanktransactionimport","routeSlug":"/api-reference/simulation/simulationbanktransactionimport","metadata":{"seo":{"title":"Simulate incoming bank transfer","description":"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."}},"httpPath":"/simulation/profiles/{profileId}/bank-transactions/import","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Simulate incoming Swift payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/simulation/simulationswiftin","routeSlug":"/api-reference/simulation/simulationswiftin","metadata":{"seo":{"title":"Simulate incoming Swift payment","description":"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."}},"httpPath":"/simulation/profiles/{profileId}/swift-in","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"}],"version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"separator","label":"Partner Support","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Cases","link":"/api-reference/case","routeSlug":"/api-reference/case","items":[{"label":"Create a  case","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/case/casecreate","routeSlug":"/api-reference/case/casecreate","metadata":{"seo":{"title":"Create a  case","description":"Cases are used to collect or transmit additional information between Partners and Wise. Use this endpoint to create a new case."}},"httpPath":"/cases","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Retrieve a case by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/case/caseget","routeSlug":"/api-reference/case/caseget","metadata":{"seo":{"title":"Retrieve a case by ID","description":"Retrieves the complete details of a support case including all public messagesand reference information."}},"httpPath":"/cases/{caseId}","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Submit a message to a case","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/case/casesubmitmessage","routeSlug":"/api-reference/case/casesubmitmessage","metadata":{"seo":{"title":"Submit a message to a case","description":"Submits a new message to an existing support case. The message type determinesthe expected structure of the submission data."}},"httpPath":"/cases/{caseId}/messages","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"separator","label":"Webhooks","variant":"secondary","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"label":"Partner support case changed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/case/eventpartnersupportcasechanged","routeSlug":"/api-reference/case/eventpartnersupportcasechanged","metadata":{"seo":{"title":"Partner support case changed","description":"Triggered every time a case is created or updated, including when a new message is added or the status changes.Note that you will also receive a webhook response when you have updated a case."}},"httpPath":"partner-support#case-changed","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"}],"version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"separator","label":"Tracking","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"group","label":"GPI Tracking","link":"/api-reference/gpi-tracking","routeSlug":"/api-reference/gpi-tracking","items":[{"label":"Look up GPI tracking","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/gpi-tracking/lookupgpitracking","routeSlug":"/api-reference/gpi-tracking/lookupgpitracking","metadata":{"seo":{"title":"Look up GPI tracking","description":"Looks up GPI tracking data for a transfer identified by identifierType and identifier."}},"httpPath":"/gpi-tracking","version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"}],"version":"latest","isDefault":true,"versionFolderId":"1b9c9f54"},{"type":"link","label":"Wise Platform API","link":"/api-reference/legacy","routeSlug":"/api-reference/legacy","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"separator","label":"Authentication","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"group","label":"OAuth Token","link":"/api-reference/legacy/oauth-token","routeSlug":"/api-reference/legacy/oauth-token","items":[{"label":"Create an OAuth token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/oauth-token/oauthtokencreate","routeSlug":"/api-reference/legacy/oauth-token/oauthtokencreate","metadata":{"seo":{"title":"Create an OAuth token","description":"Exchange credentials or authorisation grants for an OAuth 2.0 access token."}},"httpPath":"/oauth/token","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"}],"version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"separator","label":"Enhanced Security","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"group","label":"JOSE","link":"/api-reference/legacy/jose","routeSlug":"/api-reference/legacy/jose","items":[{"label":"Get Wise JOSE public key","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/jose/joseresponsepublickeysget","routeSlug":"/api-reference/legacy/jose/joseresponsepublickeysget","metadata":{"seo":{"title":"Get Wise JOSE public key","description":"Returns a public key issued by Wise."}},"httpPath":"/v1/auth/jose/response/public-keys","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Add a new client public key","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/jose/joserequestpublickeyscreate","routeSlug":"/api-reference/legacy/jose/joserequestpublickeyscreate","metadata":{"seo":{"title":"Add a new client public key","description":"Upload a client public key for request payload signing or response payload encryption."}},"httpPath":"/v1/auth/jose/request/public-keys","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Playground JWS","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/jose/joseplaygroundjws","routeSlug":"/api-reference/legacy/jose/joseplaygroundjws","metadata":{"seo":{"title":"Playground JWS","description":"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."}},"httpPath":"/v1/auth/jose/playground/jws","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Playground JWE for GET requests","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/jose/joseplaygroundjweget","routeSlug":"/api-reference/legacy/jose/joseplaygroundjweget","metadata":{"seo":{"title":"Playground JWE for GET requests","description":"Send test HTTP GET requests and receive encrypted responses."}},"httpPath":"/v1/auth/jose/playground/jwe","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Playground JWE for POST requests","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/jose/joseplaygroundjwepost","routeSlug":"/api-reference/legacy/jose/joseplaygroundjwepost","metadata":{"seo":{"title":"Playground JWE for POST requests","description":"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."}},"httpPath":"/v1/auth/jose/playground/jwe","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Playground JWE for direct encryption","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/jose/joseplaygroundjwedirectencryption","routeSlug":"/api-reference/legacy/jose/joseplaygroundjwedirectencryption","metadata":{"seo":{"title":"Playground JWE for direct encryption","description":"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."}},"httpPath":"/v1/auth/jose/playground/jwe-direct-encryption","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Playground JWS+JWE","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/jose/joseplaygroundjwsjwe","routeSlug":"/api-reference/legacy/jose/joseplaygroundjwsjwe","metadata":{"seo":{"title":"Playground JWS+JWE","description":"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."}},"httpPath":"/v1/auth/jose/playground/jwsjwe","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"}],"version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"separator","label":"Users","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Users","link":"/api-reference/legacy/user","routeSlug":"/api-reference/legacy/user","items":[{"type":"link","label":"User","link":"/api-reference/legacy/user/user","routeSlug":"/api-reference/legacy/user/user","httpVerb":"schema","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Retrieve current user by token","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/user/usergetbytoken","routeSlug":"/api-reference/legacy/user/usergetbytoken","metadata":{"seo":{"title":"Retrieve current user by token","description":"Get authenticated user details for the user's token submitted in the Authorization header."}},"httpPath":"/v1/me","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Retrieve a user by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/user/usergetbyid","routeSlug":"/api-reference/legacy/user/usergetbyid","metadata":{"seo":{"title":"Retrieve a user by ID","description":"Get authenticated user details by user ID."}},"httpPath":"/v1/users/{userId}","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Create a user with a registration code","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/user/usercreate","routeSlug":"/api-reference/legacy/user/usercreate","metadata":{"seo":{"title":"Create a user with a registration code","description":"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."}},"httpPath":"/v1/user/signup/registration_code","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Check if user exists","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/user/usercheckexists","routeSlug":"/api-reference/legacy/user/usercheckexists","metadata":{"seo":{"title":"Check if user exists","description":"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."}},"httpPath":"/v1/users/exists","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Set a contact email address","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/user/usercontactemailset","routeSlug":"/api-reference/legacy/user/usercontactemailset","metadata":{"seo":{"title":"Set a contact email address","description":"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."}},"httpPath":"/v1/users/{userId}/contact-email","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Retrieve a contact email address","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/user/usercontactemailget","routeSlug":"/api-reference/legacy/user/usercontactemailget","metadata":{"seo":{"title":"Retrieve a contact email address","description":"Retrieves a contact email address."}},"httpPath":"/v1/users/{userId}/contact-email","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"separator","label":"Webhooks","variant":"secondary","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"User state change","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/legacy/user/eventusersstatechange","routeSlug":"/api-reference/legacy/user/eventusersstatechange","metadata":{"seo":{"title":"User state change","description":"Triggered every time a user's state is updated."}},"httpPath":"users#state-change","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"}],"version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Claim Account","link":"/api-reference/legacy/claim-account","routeSlug":"/api-reference/legacy/claim-account","items":[{"label":"Generate a claim account code","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/claim-account/claimaccountcreate","routeSlug":"/api-reference/legacy/claim-account/claimaccountcreate","metadata":{"seo":{"title":"Generate a claim account code","description":"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 to finalize their account setup."}},"httpPath":"/v1/user/claim-account","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"}],"version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"separator","label":"Profiles","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Profiles","link":"/api-reference/legacy/profile","routeSlug":"/api-reference/legacy/profile","items":[{"type":"link","label":"Profile","link":"/api-reference/legacy/profile/profile","routeSlug":"/api-reference/legacy/profile/profile","httpVerb":"schema","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"List profiles for a user account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/profile/profilelist","routeSlug":"/api-reference/legacy/profile/profilelist","metadata":{"seo":{"title":"List profiles for a user account","description":"List of all profiles belonging to user."}},"httpPath":"/v2/profiles","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Create a personal profile","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/profile/profilepersonalcreate","routeSlug":"/api-reference/legacy/profile/profilepersonalcreate","metadata":{"seo":{"title":"Create a personal profile","description":"Create a personal profile for the authenticated user. A personal profile represents an individual and is required before creating transfers or business profiles."}},"httpPath":"/v2/profiles/personal-profile","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Create a business profile (V4)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/profile/profilebusinesscreatev4","routeSlug":"/api-reference/legacy/profile/profilebusinesscreatev4","metadata":{"seo":{"title":"Create a business profile (V4)","description":"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."}},"httpPath":"/v4/profiles/business-profile","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Retrieve a profile by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/profile/profileget","routeSlug":"/api-reference/legacy/profile/profileget","metadata":{"seo":{"title":"Retrieve a profile by ID","description":"Get profile info by ID."}},"httpPath":"/v2/profiles/{profileId}","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Update a personal profile","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/profile/profilepersonalupdate","routeSlug":"/api-reference/legacy/profile/profilepersonalupdate","metadata":{"seo":{"title":"Update a personal profile","description":"Update user profile information for a personal profile."}},"httpPath":"/v2/profiles/{profileId}/personal-profile","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Retrieve business representative","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/profile/profilebusinessrepresentativeget","routeSlug":"/api-reference/legacy/profile/profilebusinessrepresentativeget","metadata":{"seo":{"title":"Retrieve business representative","description":"Get Business Representative info by Business Profile ID."}},"httpPath":"/v3/profiles/{profileId}/business-profile/business-representative","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Update business representative","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/profile/profilebusinessrepresentativeupdate","routeSlug":"/api-reference/legacy/profile/profilebusinessrepresentativeupdate","metadata":{"seo":{"title":"Update business representative","description":"Update or transfer the Business Representative for the specified Business Profile."}},"httpPath":"/v3/profiles/{profileId}/business-profile/business-representative","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Create an identification document","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/profile/profileverificationdocumentcreate","routeSlug":"/api-reference/legacy/profile/profileverificationdocumentcreate","metadata":{"seo":{"title":"Create an identification document","description":"Add an identification document to a personal profile. Not applicable to business profiles."}},"httpPath":"/v1/profiles/{profileId}/verification-documents","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Update an identification document","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/profile/profileverificationdocumentupdate","routeSlug":"/api-reference/legacy/profile/profileverificationdocumentupdate","metadata":{"seo":{"title":"Update an identification document","description":"Update an existing identification document on a personal profile. Not applicable to business profiles."}},"httpPath":"/v1/profiles/{profileId}/verification-documents","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Create business directors","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/profile/profiledirectorcreate","routeSlug":"/api-reference/legacy/profile/profiledirectorcreate","metadata":{"seo":{"title":"Create business directors","description":"Adds new directors to the business profile."}},"httpPath":"/v1/profiles/{profileId}/directors","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"List business directors","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/profile/profiledirectorlist","routeSlug":"/api-reference/legacy/profile/profiledirectorlist","metadata":{"seo":{"title":"List business directors","description":"Returns the list of director objects associated with the business profile."}},"httpPath":"/v1/profiles/{profileId}/directors","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Update business directors","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/profile/profiledirectorupdate","routeSlug":"/api-reference/legacy/profile/profiledirectorupdate","metadata":{"seo":{"title":"Update business directors","description":"Overrides directors in the business profile."}},"httpPath":"/v1/profiles/{profileId}/directors","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Create business ultimate owners","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/profile/profileubocreate","routeSlug":"/api-reference/legacy/profile/profileubocreate","metadata":{"seo":{"title":"Create business ultimate owners","description":"Adds new ultimate beneficial owners to the business profile."}},"httpPath":"/v1/profiles/{profileId}/ubos","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"List business ultimate owners","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/profile/profileubolist","routeSlug":"/api-reference/legacy/profile/profileubolist","metadata":{"seo":{"title":"List business ultimate owners","description":"Returns the list of all ultimate beneficial owners associated with the business profile."}},"httpPath":"/v1/profiles/{profileId}/ubos","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Update business ultimate owners","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/profile/profileuboupdate","routeSlug":"/api-reference/legacy/profile/profileuboupdate","metadata":{"seo":{"title":"Update business ultimate owners","description":"Overrides ultimate beneficial owners in the business profile."}},"httpPath":"/v1/profiles/{profileId}/ubos","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Open an update window","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/profile/profileupdatewindowopen","routeSlug":"/api-reference/legacy/profile/profileupdatewindowopen","metadata":{"seo":{"title":"Open an update window","description":"Opens the update window for updating the profile information: details, addresses, directors, owners, others."}},"httpPath":"/v1/profiles/{profileId}/update-window","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Close an update window","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/profile/profileupdatewindowclose","routeSlug":"/api-reference/legacy/profile/profileupdatewindowclose","metadata":{"seo":{"title":"Close an update window","description":"Deletes the update window for updating the profile."}},"httpPath":"/v1/profiles/{profileId}/update-window","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Check profile verification status","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/profile/profileverificationstatuscheck","routeSlug":"/api-reference/legacy/profile/profileverificationstatuscheck","metadata":{"seo":{"title":"Check profile verification status","description":"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."}},"httpPath":"/v3/profiles/{profileId}/verification-status/bank-transfer","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Create a profile (V1)","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/profile/profilecreatev1","routeSlug":"/api-reference/legacy/profile/profilecreatev1","metadata":{"seo":{"title":"Create a profile (V1)","description":"This endpoint is deprecated. Please see the Create Personal Profile and Create Business Profile v2 endpoints."}},"httpPath":"/v1/profiles","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Update a profile (V1)","deprecated":true,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/profile/profileupdatev1","routeSlug":"/api-reference/legacy/profile/profileupdatev1","metadata":{"seo":{"title":"Update a profile (V1)","description":"This endpoint is deprecated. Please see the Update Personal Profile and Update Business Profile v2 endpoints."}},"httpPath":"/v1/profiles","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Create a business profile (V2)","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/profile/profilebusinesscreate","routeSlug":"/api-reference/legacy/profile/profilebusinesscreate","metadata":{"seo":{"title":"Create a business profile (V2)","description":"This endpoint is deprecated. New integrations should use the V4 endpoint. See Migrating to industry categories."}},"httpPath":"/v2/profiles/business-profile","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Create a business profile (V3)","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/profile/profilebusinesscreatev3","routeSlug":"/api-reference/legacy/profile/profilebusinesscreatev3","metadata":{"seo":{"title":"Create a business profile (V3)","description":"This endpoint is deprecated. See Migrating to industry categories for the current create business profile endpoint and migration steps."}},"httpPath":"/v3/profiles/business-profile","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Update a business profile (V2)","deprecated":true,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/profile/profilebusinessupdate","routeSlug":"/api-reference/legacy/profile/profilebusinessupdate","metadata":{"seo":{"title":"Update a business profile (V2)","description":"This endpoint is deprecated. See Migrating to industry categories for the current update business profile endpoint and migration steps."}},"httpPath":"/v2/profiles/{profileId}/business-profile","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Retrieve profile extension requirements","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/profile/profileextensionrequirementsget","routeSlug":"/api-reference/legacy/profile/profileextensionrequirementsget","metadata":{"seo":{"title":"Retrieve profile extension requirements","description":"This endpoint is deprecated. Please check the Additional Verification endpoints for providing additional verification details for a profile."}},"httpPath":"/v1/profiles/{profileId}/extension-requirements","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Update profile extensions dynamically","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/profile/profileextensionrequirementspost","routeSlug":"/api-reference/legacy/profile/profileextensionrequirementspost","metadata":{"seo":{"title":"Update profile extensions dynamically","description":"This endpoint is deprecated. Please check the Additional Verification endpoints for providing additional verification details for a profile."}},"httpPath":"/v1/profiles/{profileId}/extension-requirements","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Submit profile extensions","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/profile/profileextensionscreate","routeSlug":"/api-reference/legacy/profile/profileextensionscreate","metadata":{"seo":{"title":"Submit profile extensions","description":"This endpoint is deprecated. Please check the Additional Verification endpoints for providing additional verification details for a profile."}},"httpPath":"/v1/profiles/{profileId}/extensions","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Retrieve profile extensions","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/profile/profileextensionsget","routeSlug":"/api-reference/legacy/profile/profileextensionsget","metadata":{"seo":{"title":"Retrieve profile extensions","description":"This endpoint is deprecated. Please check the Additional Verification endpoints for providing additional verification details for a profile."}},"httpPath":"/v1/profiles/{profileId}/extensions","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"separator","label":"Webhooks","variant":"secondary","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Overdraft limit threshold","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/legacy/profile/eventprofilesoverdraftlimitthreshold","routeSlug":"/api-reference/legacy/profile/eventprofilesoverdraftlimitthreshold","metadata":{"seo":{"title":"Overdraft limit threshold","description":"Triggered when the overdraft limit usage has reached 70% threshold. The event at each threshold is triggered maximum once per hour."}},"httpPath":"profiles#overdraft-limit-threshold","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Profile state change","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/legacy/profile/eventprofilesstatechange","routeSlug":"/api-reference/legacy/profile/eventprofilesstatechange","metadata":{"seo":{"title":"Profile state change","description":"Triggered every time a profile's state is updated."}},"httpPath":"profiles#state-change","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Verification state change","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/legacy/profile/eventprofilesverificationstatechange","routeSlug":"/api-reference/legacy/profile/eventprofilesverificationstatechange","metadata":{"seo":{"title":"Verification state change","description":"Triggered when the verification state of a connected profile changes."}},"httpPath":"profiles#verification-state-change","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"}],"version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Activity","link":"/api-reference/legacy/activity","routeSlug":"/api-reference/legacy/activity","items":[{"label":"List Activities for a Profile","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/activity/activitylist","routeSlug":"/api-reference/legacy/activity/activitylist","metadata":{"seo":{"title":"List Activities for a Profile","description":"List of activities belonging to user profile."}},"httpPath":"/v1/profiles/{profileId}/activities","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"}],"version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Addresses","link":"/api-reference/legacy/address","routeSlug":"/api-reference/legacy/address","items":[{"type":"link","label":"Address","link":"/api-reference/legacy/address/address","routeSlug":"/api-reference/legacy/address/address","httpVerb":"schema","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Create or Update an Address","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/address/addresscreate","routeSlug":"/api-reference/legacy/address/addresscreate","metadata":{"seo":{"title":"Create or Update an Address","description":"Adds address info to user profile."}},"httpPath":"/v1/addresses","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"List Addresses for a Profile","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/address/addresslist","routeSlug":"/api-reference/legacy/address/addresslist","metadata":{"seo":{"title":"List Addresses for a Profile","description":"List of addresses belonging to user profile."}},"httpPath":"/v1/addresses","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Retrieve an Address by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/address/addressget","routeSlug":"/api-reference/legacy/address/addressget","metadata":{"seo":{"title":"Retrieve an Address by ID","description":"Get address info by ID."}},"httpPath":"/v1/addresses/{addressId}","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Get Address Requirements","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/address/addressrequirementsget","routeSlug":"/api-reference/legacy/address/addressrequirementsget","metadata":{"seo":{"title":"Get Address Requirements","description":"Returns the list of fields required to create a valid address. Use this as a starting point to discover required fields."}},"httpPath":"/v1/address-requirements","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Get Address Requirements (with context)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/address/addressrequirementspost","routeSlug":"/api-reference/legacy/address/addressrequirementspost","metadata":{"seo":{"title":"Get Address Requirements (with context)","description":"Returns the list of fields required to create a valid address, based on the provided context."}},"httpPath":"/v1/address-requirements","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"}],"version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"separator","label":"Verification","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"group","label":"KYC Review","link":"/api-reference/legacy/kyc-review","routeSlug":"/api-reference/legacy/kyc-review","items":[{"type":"link","label":"KYC Requirement","link":"/api-reference/legacy/kyc-review/kyc-requirement","routeSlug":"/api-reference/legacy/kyc-review/kyc-requirement","httpVerb":"schema","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"link","label":"KYC Review","link":"/api-reference/legacy/kyc-review/kyc-review","routeSlug":"/api-reference/legacy/kyc-review/kyc-review","httpVerb":"schema","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"link","label":"KYC Review with a Hosted KYC link","link":"/api-reference/legacy/kyc-review/kyc-review-with-link","routeSlug":"/api-reference/legacy/kyc-review/kyc-review-with-link","httpVerb":"schema","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Create a KYC Review","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/kyc-review/kycreviewcreate","routeSlug":"/api-reference/legacy/kyc-review/kycreviewcreate","metadata":{"seo":{"title":"Create a KYC Review","description":"Creates a KYC Review for a specific customer action."}},"httpPath":"/v1/profiles/{profileId}/kyc-reviews","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Get all KYC Reviews for a profile","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/kyc-review/kycreviewlist","routeSlug":"/api-reference/legacy/kyc-review/kycreviewlist","metadata":{"seo":{"title":"Get all KYC Reviews for a profile","description":"Retrieves a list of all active KYC Reviews for a given profile."}},"httpPath":"/v1/profiles/{profileId}/kyc-reviews","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Update KYC Review to get a Hosted KYC link","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/kyc-review/kycreviewredirecturlupdate","routeSlug":"/api-reference/legacy/kyc-review/kycreviewredirecturlupdate","metadata":{"seo":{"title":"Update KYC Review to get a Hosted KYC link","description":"Updates the KYC Review with a redirect URL."}},"httpPath":"/v1/profiles/{profileId}/kyc-reviews/{kycReviewId}","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Get KYC Review by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/kyc-review/kycreviewget","routeSlug":"/api-reference/legacy/kyc-review/kycreviewget","metadata":{"seo":{"title":"Get KYC Review by ID","description":"Retrieves a single KYC Review by ID for a profile."}},"httpPath":"/v2/profiles/{profileId}/kyc-reviews/{kycReviewId}","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Submit a KYC Requirement","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/kyc-review/kycreviewrequirementsubmit","routeSlug":"/api-reference/legacy/kyc-review/kycreviewrequirementsubmit","metadata":{"seo":{"title":"Submit a KYC Requirement","description":"Submit a KYC requirement for a KYC Review."}},"httpPath":"/v2/profiles/{profileId}/kyc-requirements/{requirementKey}","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Get KYC Review by ID (V1)","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/kyc-review/kycreviewgetv1","routeSlug":"/api-reference/legacy/kyc-review/kycreviewgetv1","metadata":{"seo":{"title":"Get KYC Review by ID (V1)","description":"This endpoint is deprecated. Use Get KYC Review by ID (V2) instead."}},"httpPath":"/v1/profiles/{profileId}/kyc-reviews/{kycReviewId}","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"separator","label":"Webhooks","variant":"secondary","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"KYC review state change","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/legacy/kyc-review/eventkycreviewsstatechange","routeSlug":"/api-reference/legacy/kyc-review/eventkycreviewsstatechange","metadata":{"seo":{"title":"KYC review state change","description":"Triggered when a KYC review state has changed."}},"httpPath":"kyc-reviews#state-change","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"}],"version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Additional Verification","link":"/api-reference/legacy/verification","routeSlug":"/api-reference/legacy/verification","items":[{"label":"Upload Evidences","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/verification/verificationuploadevidences","routeSlug":"/api-reference/legacy/verification/verificationuploadevidences","metadata":{"seo":{"title":"Upload Evidences","description":"Uploads verification evidence for a specific profile."}},"httpPath":"/v5/profiles/{profileId}/additional-verification/upload-evidences","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Upload Document","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/verification/verificationuploaddocument","routeSlug":"/api-reference/legacy/verification/verificationuploaddocument","metadata":{"seo":{"title":"Upload Document","description":"Uploads verification documents for review. You can upload multiple files at once."}},"httpPath":"/v3/profiles/{profileId}/verification-status/upload-document","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Required Evidences","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/verification/verificationgetrequiredevidences","routeSlug":"/api-reference/legacy/verification/verificationgetrequiredevidences","metadata":{"seo":{"title":"Required Evidences","description":"Fetches the required evidences for a profile to complete additional customer verification."}},"httpPath":"/v3/profiles/{profileId}/verification-status/required-evidences","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Upload Evidences (v3)","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/verification/verificationuploadevidencesv3","routeSlug":"/api-reference/legacy/verification/verificationuploadevidencesv3","metadata":{"seo":{"title":"Upload Evidences (v3)","description":"Uploads verification evidence for a specific profile."}},"httpPath":"/v3/profiles/{profileId}/additional-verification/upload-evidences","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"separator","label":"Webhooks","variant":"secondary","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Additional verification state change","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/legacy/verification/eventprofilescddcheckstatechange","routeSlug":"/api-reference/legacy/verification/eventprofilescddcheckstatechange","metadata":{"seo":{"title":"Additional verification state change","description":"This event pushes updates for the Additional Customer Verification process."}},"httpPath":"profiles#cdd-check-state-change","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"}],"version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"group","label":"FaceTec","link":"/api-reference/legacy/facetec","routeSlug":"/api-reference/legacy/facetec","items":[{"label":"Get FaceTec public key","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/facetec/facetecpublickeyget","routeSlug":"/api-reference/legacy/facetec/facetecpublickeyget","metadata":{"seo":{"title":"Get FaceTec public key","description":"Retrieve Wise's FaceTec public key to be used when exporting 3D FaceMap from your FaceTec host to Wise."}},"httpPath":"/v1/facetec/public-key","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"}],"version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"separator","label":"Strong Customer Authentication","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"group","label":"One Time Token","link":"/api-reference/legacy/sca-ott","routeSlug":"/api-reference/legacy/sca-ott","items":[{"type":"link","label":"One-Time Token","link":"/api-reference/legacy/sca-ott/one-time-token","routeSlug":"/api-reference/legacy/sca-ott/one-time-token","httpVerb":"schema","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Get status of a one time token","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/sca-ott/ottstatusget","routeSlug":"/api-reference/legacy/sca-ott/ottstatusget","metadata":{"seo":{"title":"Get status of a one time token","description":"Retrieve necessary information to clear a OTT."}},"httpPath":"/v1/one-time-token/status","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Get OTT status (v1)","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/sca-ott/ottstatusgetv1","routeSlug":"/api-reference/legacy/sca-ott/ottstatusgetv1","metadata":{"seo":{"title":"Get OTT status (v1)","description":"This endpoint is deprecated. Use the new endpoint to get status of a one time token instead."}},"httpPath":"/v1/identity/one-time-token/status","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"}],"version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"group","label":"SCA Sessions","link":"/api-reference/legacy/sca-sessions","routeSlug":"/api-reference/legacy/sca-sessions","items":[{"label":"Create a SCA session","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/sca-sessions/scasessioncreate","routeSlug":"/api-reference/legacy/sca-sessions/scasessioncreate","metadata":{"seo":{"title":"Create a SCA session","description":"Manually triggers SCA, returning a one-time token along with a list of associated challenges. These challenges can be cleared with the verify endpoints."}},"httpPath":"/v2/profiles/{profileId}/sca-sessions/authorise","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"}],"version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"group","label":"PIN","link":"/api-reference/legacy/sca-pin","routeSlug":"/api-reference/legacy/sca-pin","items":[{"label":"Create a PIN","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/sca-pin/scapincreate","routeSlug":"/api-reference/legacy/sca-pin/scapincreate","metadata":{"seo":{"title":"Create a PIN","description":"Creates a new PIN factor used to resolve a SCA knowledge challenge type."}},"httpPath":"/v2/profiles/{profileId}/pin","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Delete a PIN","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/sca-pin/scapindelete","routeSlug":"/api-reference/legacy/sca-pin/scapindelete","metadata":{"seo":{"title":"Delete a PIN","description":"Deletes a PIN associated to a profile."}},"httpPath":"/v2/profiles/{profileId}/pin","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Verify a PIN","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/sca-pin/scapinverify","routeSlug":"/api-reference/legacy/sca-pin/scapinverify","metadata":{"seo":{"title":"Verify a PIN","description":"Verifies a PIN challenge when calling a SCA-secured endpoint. Make sure to create a PIN before using this endpoint."}},"httpPath":"/v2/profiles/{profileId}/pin/verify","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Verify PIN","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/sca-pin/ottpinverify","routeSlug":"/api-reference/legacy/sca-pin/ottpinverify","metadata":{"seo":{"title":"Verify PIN","description":"Verify PIN"}},"httpPath":"/v1/one-time-token/pin/verify","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"}],"version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Facemaps","link":"/api-reference/legacy/sca-facemaps","routeSlug":"/api-reference/legacy/sca-facemaps","items":[{"label":"Create a facemap","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/sca-facemaps/scafacemapcreate","routeSlug":"/api-reference/legacy/sca-facemaps/scafacemapcreate","metadata":{"seo":{"title":"Create a facemap","description":"Creates a new facemap factor used to resolve a SCA inherence challenge type."}},"httpPath":"/v2/profiles/{profileId}/facemaps","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Delete a facemap","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/sca-facemaps/scafacemapdelete","routeSlug":"/api-reference/legacy/sca-facemaps/scafacemapdelete","metadata":{"seo":{"title":"Delete a facemap","description":"Deletes a facemap associated to a profile."}},"httpPath":"/v2/profiles/{profileId}/facemaps","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Verify a facemap","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/sca-facemaps/scafacemapverify","routeSlug":"/api-reference/legacy/sca-facemaps/scafacemapverify","metadata":{"seo":{"title":"Verify a facemap","description":"Verifies a facemap challenge when calling a SCA-secured endpoint. Make sure to create a facemap before using this endpoint."}},"httpPath":"/v2/profiles/{profileId}/facemaps/verify","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Verify FaceMap","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/sca-facemaps/ottfacemapverify","routeSlug":"/api-reference/legacy/sca-facemaps/ottfacemapverify","metadata":{"seo":{"title":"Verify FaceMap","description":"To clear a FACE_MAP challenge listed in a OTT."}},"httpPath":"/v1/one-time-token/facemap/verify","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"}],"version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Device Fingerprints","link":"/api-reference/legacy/sca-device-fingerprints","routeSlug":"/api-reference/legacy/sca-device-fingerprints","items":[{"label":"Create a device fingerprint","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/sca-device-fingerprints/scadevicefingerprintcreate","routeSlug":"/api-reference/legacy/sca-device-fingerprints/scadevicefingerprintcreate","metadata":{"seo":{"title":"Create a device fingerprint","description":"Creates a new device fingerprint factor used to resolve a SCA possession challenge type."}},"httpPath":"/v2/profiles/{profileId}/device-fingerprints","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Verify a device fingerprint","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/sca-device-fingerprints/scadevicefingerprintverify","routeSlug":"/api-reference/legacy/sca-device-fingerprints/scadevicefingerprintverify","metadata":{"seo":{"title":"Verify a device fingerprint","description":"Verifies a device fingerprint challenge when calling a SCA-secured endpoint. Make sure to create a device fingerprint before using this endpoint."}},"httpPath":"/v2/profiles/{profileId}/device-fingerprints/verify","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Delete a device fingerprint","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/sca-device-fingerprints/scadevicefingerprintdelete","routeSlug":"/api-reference/legacy/sca-device-fingerprints/scadevicefingerprintdelete","metadata":{"seo":{"title":"Delete a device fingerprint","description":"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."}},"httpPath":"/v2/profiles/{profileId}/device-fingerprints/{deviceFingerprintId}","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Verify Device Fingerprint","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/sca-device-fingerprints/ottdevicefingerprintverify","routeSlug":"/api-reference/legacy/sca-device-fingerprints/ottdevicefingerprintverify","metadata":{"seo":{"title":"Verify Device Fingerprint","description":"Verify Device Fingerprint"}},"httpPath":"/v1/one-time-token/partner-device-fingerprint/verify","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"}],"version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"group","label":"OTP","link":"/api-reference/legacy/sca-otp","routeSlug":"/api-reference/legacy/sca-otp","items":[{"label":"Create Phone Number","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/sca-otp/usersecurityphonenumbercreate","routeSlug":"/api-reference/legacy/sca-otp/usersecurityphonenumbercreate","metadata":{"seo":{"title":"Create Phone Number","description":"Create a verified phone number for a user."}},"httpPath":"/v1/application/users/{userId}/phone-numbers","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Trigger SMS Challenge","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/sca-otp/ottsmstrigger","routeSlug":"/api-reference/legacy/sca-otp/ottsmstrigger","metadata":{"seo":{"title":"Trigger SMS Challenge","description":"To trigger a SMS challenge by sending SMS to user verified phone number containing a 6 digit one time password (OTP)."}},"httpPath":"/v1/one-time-token/sms/trigger","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Verify SMS Challenge","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/sca-otp/ottsmsverify","routeSlug":"/api-reference/legacy/sca-otp/ottsmsverify","metadata":{"seo":{"title":"Verify SMS Challenge","description":"To clear a SMS challenge listed in a OTT."}},"httpPath":"/v1/one-time-token/sms/verify","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Trigger WhatsApp Challenge","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/sca-otp/ottwhatsapptrigger","routeSlug":"/api-reference/legacy/sca-otp/ottwhatsapptrigger","metadata":{"seo":{"title":"Trigger WhatsApp Challenge","description":"To trigger a WhatsApp challenge by sending WhatsApp message to user verified phone number containing a 6 digit one time password (OTP)."}},"httpPath":"/v1/one-time-token/whatsapp/trigger","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Verify WhatsApp Challenge","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/sca-otp/ottwhatsappverify","routeSlug":"/api-reference/legacy/sca-otp/ottwhatsappverify","metadata":{"seo":{"title":"Verify WhatsApp Challenge","description":"To clear a WHATSAPP challenge listed in a OTT."}},"httpPath":"/v1/one-time-token/whatsapp/verify","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Trigger Voice Challenge","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/sca-otp/ottvoicetrigger","routeSlug":"/api-reference/legacy/sca-otp/ottvoicetrigger","metadata":{"seo":{"title":"Trigger Voice Challenge","description":"To trigger a Voice challenge by sending voice message to user verified phone number containing a 6 digit one time password (OTP)."}},"httpPath":"/v1/one-time-token/voice/trigger","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Verify Voice Challenge","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/sca-otp/ottvoiceverify","routeSlug":"/api-reference/legacy/sca-otp/ottvoiceverify","metadata":{"seo":{"title":"Verify Voice Challenge","description":"To clear a VOICE challenge listed in a OTT."}},"httpPath":"/v1/one-time-token/voice/verify","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Delete Phone Number","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/sca-otp/usersecurityphonenumberdelete","routeSlug":"/api-reference/legacy/sca-otp/usersecurityphonenumberdelete","metadata":{"seo":{"title":"Delete Phone Number","description":"Delete a verified phone number for a user."}},"httpPath":"/v1/application/users/{userId}/phone-numbers/{phoneNumberId}","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"}],"version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"group","label":"User Security","link":"/api-reference/legacy/user-security","routeSlug":"/api-reference/legacy/user-security","items":[{"label":"List Phone Numbers","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/user-security/usersecurityphonenumberlist","routeSlug":"/api-reference/legacy/user-security/usersecurityphonenumberlist","metadata":{"seo":{"title":"List Phone Numbers","description":"List verified phone numbers for a user."}},"httpPath":"/v1/application/users/{userId}/phone-numbers","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Update Phone Number","deprecated":true,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/user-security/usersecurityphonenumberupdate","routeSlug":"/api-reference/legacy/user-security/usersecurityphonenumberupdate","metadata":{"seo":{"title":"Update Phone Number","description":"Update a verified phone number for a user."}},"httpPath":"/v1/application/users/{userId}/phone-numbers/{phoneNumberId}","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Create PIN","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/user-security/usersecuritypincreate","routeSlug":"/api-reference/legacy/user-security/usersecuritypincreate","metadata":{"seo":{"title":"Create PIN","description":"Create PIN for a user as a form of authentication."}},"httpPath":"/v1/user/pin","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Delete PIN","deprecated":true,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/user-security/usersecuritypindelete","routeSlug":"/api-reference/legacy/user-security/usersecuritypindelete","metadata":{"seo":{"title":"Delete PIN","description":"Remove the PIN from the user's account."}},"httpPath":"/v1/users/{userId}/pin","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Enrol FaceMap","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/user-security/usersecurityfacemapenrol","routeSlug":"/api-reference/legacy/user-security/usersecurityfacemapenrol","metadata":{"seo":{"title":"Enrol FaceMap","description":"Facial biometric enrolment for Strong Customer Authentication (SCA)."}},"httpPath":"/v1/user/facemap/enrol","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Delete FaceMap","deprecated":true,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/user-security/usersecurityfacemapdelete","routeSlug":"/api-reference/legacy/user-security/usersecurityfacemapdelete","metadata":{"seo":{"title":"Delete FaceMap","description":"Remove the FaceMap from the user's account."}},"httpPath":"/v1/users/{userId}/facemap/enrol","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Create Device Fingerprint","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/user-security/usersecuritydevicefingerprintcreate","routeSlug":"/api-reference/legacy/user-security/usersecuritydevicefingerprintcreate","metadata":{"seo":{"title":"Create Device Fingerprint","description":"A device fingerprint represents a string that identifies a unique device."}},"httpPath":"/v1/user/partner-device-fingerprints","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"List Device Fingerprints","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/user-security/usersecuritydevicefingerprintlist","routeSlug":"/api-reference/legacy/user-security/usersecuritydevicefingerprintlist","metadata":{"seo":{"title":"List Device Fingerprints","description":"Returns a list of device fingerprints created for this user."}},"httpPath":"/v1/users/{userId}/partner-device-fingerprints","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Delete Device Fingerprint","deprecated":true,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/user-security/usersecuritydevicefingerprintdelete","routeSlug":"/api-reference/legacy/user-security/usersecuritydevicefingerprintdelete","metadata":{"seo":{"title":"Delete Device Fingerprint","description":"Remove a specific device fingerprint from the allowed devices of a user."}},"httpPath":"/v1/users/{userId}/partner-device-fingerprints/{deviceFingerprintId}","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"}],"version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"separator","label":"Balances","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Balances","link":"/api-reference/legacy/balance","routeSlug":"/api-reference/legacy/balance","items":[{"type":"link","label":"Balance","link":"/api-reference/legacy/balance/balance","routeSlug":"/api-reference/legacy/balance/balance","httpVerb":"schema","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"link","label":"HoldLimitBreach","link":"/api-reference/legacy/balance/holdlimitbreach","routeSlug":"/api-reference/legacy/balance/holdlimitbreach","httpVerb":"schema","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Create a Balance Account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/balance/balancecreate","routeSlug":"/api-reference/legacy/balance/balancecreate","metadata":{"seo":{"title":"Create a Balance Account","description":"Opens a balance within the specified profile, in the currency and type specified in the request."}},"httpPath":"/v4/profiles/{profileId}/balances","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"List Balances for a Profile","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/balance/balancelist","routeSlug":"/api-reference/legacy/balance/balancelist","metadata":{"seo":{"title":"List Balances for a Profile","description":"Retrieves the user's multi-currency account balance accounts. Returns all balance accounts the profile has in the types specified."}},"httpPath":"/v4/profiles/{profileId}/balances","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Retrieve a Balance by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/balance/balanceget","routeSlug":"/api-reference/legacy/balance/balanceget","metadata":{"seo":{"title":"Retrieve a Balance by ID","description":"Returns a balance based on the specified balance ID."}},"httpPath":"/v4/profiles/{profileId}/balances/{balanceId}","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Remove a Balance Account","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/balance/balancedelete","routeSlug":"/api-reference/legacy/balance/balancedelete","metadata":{"seo":{"title":"Remove a Balance Account","description":"Closes a balance account for the user's profile."}},"httpPath":"/v4/profiles/{profileId}/balances/{balanceId}","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Convert or Move Money Between Balances","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/balance/balancemovement","routeSlug":"/api-reference/legacy/balance/balancemovement","metadata":{"seo":{"title":"Convert or Move Money Between Balances","description":"This endpoint allows conversion and movement of funds between balance accounts."}},"httpPath":"/v2/profiles/{profileId}/balance-movements","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Retrieve Deposit Limits","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/balance/balancecapacity","routeSlug":"/api-reference/legacy/balance/balancecapacity","metadata":{"seo":{"title":"Retrieve Deposit Limits","description":"Returns the deposit limit for a profile based on regulatory requirements."}},"httpPath":"/v1/profiles/{profileId}/balance-capacity","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Add an Excess Money Account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/balance/excessmoneyaccount","routeSlug":"/api-reference/legacy/balance/excessmoneyaccount","metadata":{"seo":{"title":"Add an Excess Money Account","description":"If a balance goes over the regulatory hold limit, excess funds are automatically moved to another account at the end of the day."}},"httpPath":"/v1/profiles/{profileId}/excess-money-account","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Get Total Funds","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/balance/totalfunds","routeSlug":"/api-reference/legacy/balance/totalfunds","metadata":{"seo":{"title":"Get Total Funds","description":"Provides an overview of your account's total valuation and available liquidity across all balances."}},"httpPath":"/v1/profiles/{profileId}/total-funds/{currency}","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"List hold limit breaches","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/balance/holdlimitbreachlist","routeSlug":"/api-reference/legacy/balance/holdlimitbreachlist","metadata":{"seo":{"title":"List hold limit breaches","description":"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)."}},"httpPath":"/v1/profiles/{profileId}/balances/hold-limit-breach","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Close a hold limit breach","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/balance/holdlimitbreachclose","routeSlug":"/api-reference/legacy/balance/holdlimitbreachclose","metadata":{"seo":{"title":"Close a hold limit breach","description":"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."}},"httpPath":"/v1/profiles/{profileId}/balances/hold-limit-breach/{holdLimitBreachId}","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Get account balance (v1)","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/balance/balancegetv1","routeSlug":"/api-reference/legacy/balance/balancegetv1","metadata":{"seo":{"title":"Get account balance (v1)","description":"This endpoint is deprecated. Use the v4 Balances endpoint instead."}},"httpPath":"/v1/borderless-accounts","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Convert currencies between balances (v1)","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/balance/balanceconvertv1","routeSlug":"/api-reference/legacy/balance/balanceconvertv1","metadata":{"seo":{"title":"Convert currencies between balances (v1)","description":"This endpoint is deprecated. Use the balance movements endpoint to move and convert between balances instead."}},"httpPath":"/v1/borderless-accounts/{borderlessAccountId}/conversions","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"separator","label":"Webhooks","variant":"secondary","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Hold limit breach update","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/legacy/balance/eventholdlimitbreachupdate","routeSlug":"/api-reference/legacy/balance/eventholdlimitbreachupdate","metadata":{"seo":{"title":"Hold limit breach update","description":"Triggered whenever a hold limit breach is opened or closed for a profile. A hold limit breach occurs when a balance exceeds the regulatory hold limit (applicable in countries such as Singapore and Malaysia)."}},"httpPath":"hold-limit-breach#update","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Balance update","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/legacy/balance/eventbalancesupdate","routeSlug":"/api-reference/legacy/balance/eventbalancesupdate","metadata":{"seo":{"title":"Balance update","description":"Triggered every time a multi-currency account is credited or debited."}},"httpPath":"balances#update","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Balance account state change","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/legacy/balance/eventbalancesaccountstatechange","routeSlug":"/api-reference/legacy/balance/eventbalancesaccountstatechange","metadata":{"seo":{"title":"Balance account state change","description":"Triggered every time a balance account is activated or deactivated."}},"httpPath":"balances#account-state-change","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Balance credit","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/legacy/balance/eventbalancescredit","routeSlug":"/api-reference/legacy/balance/eventbalancescredit","metadata":{"seo":{"title":"Balance credit","description":"Triggered every time a multi-currency account is credited."}},"httpPath":"balances#credit","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"}],"version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Balance Statements","link":"/api-reference/legacy/balance-statement","routeSlug":"/api-reference/legacy/balance-statement","items":[{"label":"Get Balance Statement","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/balance-statement/balancestatementget","routeSlug":"/api-reference/legacy/balance-statement/balancestatementget","metadata":{"seo":{"title":"Get Balance Statement","description":"Retrieve a statement for the specified balance account."}},"httpPath":"/v1/profiles/{profileId}/balance-statements/{balanceId}/statement.json","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"}],"version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Bank Account Details","link":"/api-reference/legacy/bank-account-details","routeSlug":"/api-reference/legacy/bank-account-details","items":[{"type":"link","label":"Bank Account Details","link":"/api-reference/legacy/bank-account-details/bankaccountdetails","routeSlug":"/api-reference/legacy/bank-account-details/bankaccountdetails","httpVerb":"schema","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Create bank account details order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/bank-account-details/bankaccountdetailsordercreate","routeSlug":"/api-reference/legacy/bank-account-details/bankaccountdetailsordercreate","metadata":{"seo":{"title":"Create bank account details order","description":"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."}},"httpPath":"/v1/profiles/{profileId}/account-details-orders","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Create multiple bank account details","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/bank-account-details/bankaccountdetailsbankdetailscreate","routeSlug":"/api-reference/legacy/bank-account-details/bankaccountdetailsbankdetailscreate","metadata":{"seo":{"title":"Create multiple bank account details","description":"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."}},"httpPath":"/v3/profiles/{profileId}/bank-details","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Retrieve bank account details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/bank-account-details/bankaccountdetailsget","routeSlug":"/api-reference/legacy/bank-account-details/bankaccountdetailsget","metadata":{"seo":{"title":"Retrieve bank account details","description":"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."}},"httpPath":"/v1/profiles/{profileId}/account-details","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"List bank account detail orders","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/bank-account-details/bankaccountdetailsorderslist","routeSlug":"/api-reference/legacy/bank-account-details/bankaccountdetailsorderslist","metadata":{"seo":{"title":"List bank account detail orders","description":"Returns the bank account assignment requests for a profile and multi-currency account."}},"httpPath":"/v3/profiles/{profileId}/account-details-orders","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Create payment return","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/bank-account-details/bankaccountdetailsreturnscreate","routeSlug":"/api-reference/legacy/bank-account-details/bankaccountdetailsreturnscreate","metadata":{"seo":{"title":"Create payment return","description":"Creates a return for a payment received to bank account details."}},"httpPath":"/v1/profiles/{profileId}/account-details/payments/{paymentId}/returns","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"List bank account detail orders (v1)","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/bank-account-details/bankaccountdetailsorderslistv1","routeSlug":"/api-reference/legacy/bank-account-details/bankaccountdetailsorderslistv1","metadata":{"seo":{"title":"List bank account detail orders (v1)","description":"Returns the bank account assignment requests for a profile and multi-currency account."}},"httpPath":"/v1/profiles/{profileId}/account-details-orders","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"separator","label":"Webhooks","variant":"secondary","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Account details order state change","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/legacy/bank-account-details/eventaccountdetailsorderstatechange","routeSlug":"/api-reference/legacy/bank-account-details/eventaccountdetailsorderstatechange","metadata":{"seo":{"title":"Account details order state change","description":"The event contains information about the order state and requirement state. Triggered when there is a change in the state of an account details order."}},"httpPath":"account-details-order#order-state-change","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Account details payment state change","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/legacy/bank-account-details/eventaccountdetailspaymentstatechange","routeSlug":"/api-reference/legacy/bank-account-details/eventaccountdetailspaymentstatechange","metadata":{"seo":{"title":"Account details payment state change","description":"Triggered every time a pay-in is made into the specified account details."}},"httpPath":"account-details-payment#state-change","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"}],"version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Multi Currency Account","link":"/api-reference/legacy/multi-currency-account","routeSlug":"/api-reference/legacy/multi-currency-account","items":[{"label":"Retrieve available currencies","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/multi-currency-account/mcaavailablecurrenciesget","routeSlug":"/api-reference/legacy/multi-currency-account/mcaavailablecurrenciesget","metadata":{"seo":{"title":"Retrieve available currencies","description":"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."}},"httpPath":"/v2/borderless-accounts-configuration/profiles/{profileId}/available-currencies","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Retrieve payin currencies","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/multi-currency-account/mcapayincurrenciesget","routeSlug":"/api-reference/legacy/multi-currency-account/mcapayincurrenciesget","metadata":{"seo":{"title":"Retrieve payin currencies","description":"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."}},"httpPath":"/v2/borderless-accounts-configuration/profiles/{profileId}/payin-currencies","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Retrieve multi currency account for a profile","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/multi-currency-account/mcaget","routeSlug":"/api-reference/legacy/multi-currency-account/mcaget","metadata":{"seo":{"title":"Retrieve multi currency account for a profile","description":"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."}},"httpPath":"/v4/profiles/{profileId}/multi-currency-account","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Retrieve multi currency account eligibility","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/multi-currency-account/mcaeligibilityget","routeSlug":"/api-reference/legacy/multi-currency-account/mcaeligibilityget","metadata":{"seo":{"title":"Retrieve multi currency account eligibility","description":"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."}},"httpPath":"/v4/multi-currency-account/eligibility","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"}],"version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"separator","label":"Issuing","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Cards","link":"/api-reference/legacy/card","routeSlug":"/api-reference/legacy/card","items":[{"type":"link","label":"Card","link":"/api-reference/legacy/card/card","routeSlug":"/api-reference/legacy/card/card","httpVerb":"schema","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"link","label":"Permission","link":"/api-reference/legacy/card/permission","routeSlug":"/api-reference/legacy/card/permission","httpVerb":"schema","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"List cards for a profile","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/card/cardlist","routeSlug":"/api-reference/legacy/card/cardlist","metadata":{"seo":{"title":"List cards for a profile","description":"Returns a paginated list of cards that belong to a specific profile."}},"httpPath":"/v3/spend/profiles/{profileId}/cards","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Get card details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/card/cardget","routeSlug":"/api-reference/legacy/card/cardget","metadata":{"seo":{"title":"Get card details","description":"Retrieves details for a specific card by its token."}},"httpPath":"/v3/spend/profiles/{profileId}/cards/{cardToken}","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Update card status","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/card/cardstatusupdate","routeSlug":"/api-reference/legacy/card/cardstatusupdate","metadata":{"seo":{"title":"Update card status","description":"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."}},"httpPath":"/v3/spend/profiles/{profileId}/cards/{cardToken}/status","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Reset PIN count","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/card/cardpincountreset","routeSlug":"/api-reference/legacy/card/cardpincountreset","metadata":{"seo":{"title":"Reset PIN count","description":"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."}},"httpPath":"/v3/spend/profiles/{profileId}/cards/{cardToken}/reset-pin-count","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Get card spending permissions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/card/cardpermissionsget","routeSlug":"/api-reference/legacy/card/cardpermissionsget","metadata":{"seo":{"title":"Get card spending permissions","description":"Retrieves the current spending permissions configured for a card."}},"httpPath":"/v3/spend/profiles/{profileId}/cards/{cardToken}/spending-permissions","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Bulk update card permissions","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/card/cardpermissionsbulkupdate","routeSlug":"/api-reference/legacy/card/cardpermissionsbulkupdate","metadata":{"seo":{"title":"Bulk update card permissions","description":"Enable or disable multiple spending permissions on a card in a single request."}},"httpPath":"/v4/spend/profiles/{profileId}/cards/{cardToken}/spending-permissions","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Update a single card permission","deprecated":true,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/card/cardpermissionsupdate","routeSlug":"/api-reference/legacy/card/cardpermissionsupdate","metadata":{"seo":{"title":"Update a single card permission","description":"Enable or disable a single spending permission on a card."}},"httpPath":"/v3/spend/profiles/{profileId}/cards/{cardToken}/spending-permissions","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Update phone number","deprecated":true,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/card/cardphonenumberupdate","routeSlug":"/api-reference/legacy/card/cardphonenumberupdate","metadata":{"seo":{"title":"Update phone number","description":"This 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. See 3DS for more information."}},"httpPath":"/v3/spend/profiles/{profileId}/cards/{cardToken}/phone-number","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"separator","label":"Webhooks","variant":"secondary","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Card status change","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/legacy/card/eventcardscardstatuschange","routeSlug":"/api-reference/legacy/card/eventcardscardstatuschange","metadata":{"seo":{"title":"Card status change","description":"This event is triggered for the initial card status as well as any subsequent updates."}},"httpPath":"cards#card-status-change","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Cards manual provisioning verification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/legacy/card/eventcardsmanualprovisioningverification","routeSlug":"/api-reference/legacy/card/eventcardsmanualprovisioningverification","metadata":{"seo":{"title":"Cards manual provisioning verification","description":"Triggered when a card is manually added to a wallet provider, and the verification methods required to complete the wallet provisioning are returned."}},"httpPath":"cards#manual-provisioning-verification","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"}],"version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Sensitive Card Details","link":"/api-reference/legacy/card-sensitive-details","routeSlug":"/api-reference/legacy/card-sensitive-details","items":[{"label":"Fetch RSA encryption key","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/card-sensitive-details/cardencryptionkeyget","routeSlug":"/api-reference/legacy/card-sensitive-details/cardencryptionkeyget","metadata":{"seo":{"title":"Fetch RSA encryption key","description":"Fetches Wise's RSA public key required for encrypting sensitive card data requests."}},"httpPath":"/twcard-data/v1/clientSideEncryption/fetchEncryptingKey","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Get sensitive card details","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/card-sensitive-details/cardsensitivedetailsget","routeSlug":"/api-reference/legacy/card-sensitive-details/cardsensitivedetailsget","metadata":{"seo":{"title":"Get sensitive card details","description":"Fetches the card's Primary Account Number (PAN), security code (CVV2), expiry date, and cardholder name."}},"httpPath":"/twcard-data/v1/sensitive-card-data/details","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Get card PIN","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/card-sensitive-details/cardpinget","routeSlug":"/api-reference/legacy/card-sensitive-details/cardpinget","metadata":{"seo":{"title":"Get card PIN","description":"Fetches the card's PIN."}},"httpPath":"/twcard-data/v1/sensitive-card-data/pin","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"}],"version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"group","label":"3D Secure Authentication","link":"/api-reference/legacy/3ds","routeSlug":"/api-reference/legacy/3ds","items":[{"label":"Inform challenge result","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/3ds/3dschallengeresultpost","routeSlug":"/api-reference/legacy/3ds/3dschallengeresultpost","metadata":{"seo":{"title":"Inform challenge result","description":"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."}},"httpPath":"/v3/spend/profiles/{profileId}/3dsecure/challenge-result","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"separator","label":"Webhooks","variant":"secondary","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"3DS challenge","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/legacy/3ds/eventcards3dschallenge","routeSlug":"/api-reference/legacy/3ds/eventcards3dschallenge","metadata":{"seo":{"title":"3DS challenge","description":"Triggered when a customer initiates a push notification for 3DS. The provided information can be used to send a push notification to the customer's mobile app."}},"httpPath":"cards#3ds-challenge","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"}],"version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Card Kiosk Collection","link":"/api-reference/legacy/card-kiosk-collection","routeSlug":"/api-reference/legacy/card-kiosk-collection","items":[{"label":"Produce a card","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/card-kiosk-collection/cardkioskcollectionproduce","routeSlug":"/api-reference/legacy/card-kiosk-collection/cardkioskcollectionproduce","metadata":{"seo":{"title":"Produce a card","description":"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 webhook with status READY."}},"httpPath":"/v3/spend/profiles/{profileId}/cards/{cardToken}/production","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Retrieve card production status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/card-kiosk-collection/cardkioskcollectionproductionget","routeSlug":"/api-reference/legacy/card-kiosk-collection/cardkioskcollectionproductionget","metadata":{"seo":{"title":"Retrieve card production status","description":"Retrieves the current production status of a card at a kiosk machine."}},"httpPath":"/v3/spend/profiles/{profileId}/cards/{cardToken}/production","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"separator","label":"Webhooks","variant":"secondary","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Card production status change","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/legacy/card-kiosk-collection/eventcardscardproductionstatuschange","routeSlug":"/api-reference/legacy/card-kiosk-collection/eventcardscardproductionstatuschange","metadata":{"seo":{"title":"Card production status change","description":"Triggered every time a card production status is updated. This webhook is solely used for physical cards with KIOSK_COLLECTION delivery method."}},"httpPath":"cards#card-production-status-change","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"}],"version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Card Orders","link":"/api-reference/legacy/card-order","routeSlug":"/api-reference/legacy/card-order","items":[{"type":"link","label":"Card Order","link":"/api-reference/legacy/card-order/cardorder","routeSlug":"/api-reference/legacy/card-order/cardorder","httpVerb":"schema","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Set card PIN","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/card-order/cardorderpresetpin","routeSlug":"/api-reference/legacy/card-order/cardorderpresetpin","metadata":{"seo":{"title":"Set card PIN","description":"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."}},"httpPath":"/twcard-data/v1/sensitive-card-data/preset-pin","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Create a card order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/card-order/cardordercreate","routeSlug":"/api-reference/legacy/card-order/cardordercreate","metadata":{"seo":{"title":"Create a card order","description":"Creates a new card order. The program field value is retrieved from the retrieve all card programs endpoint."}},"httpPath":"/v3/spend/profiles/{profileId}/card-orders","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Retrieve all card orders","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/card-order/cardorderlist","routeSlug":"/api-reference/legacy/card-order/cardorderlist","metadata":{"seo":{"title":"Retrieve all card orders","description":"Retrieves a list of card orders created for the specified profileId."}},"httpPath":"/v3/spend/profiles/{profileId}/card-orders","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Retrieve a card order","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/card-order/cardorderget","routeSlug":"/api-reference/legacy/card-order/cardorderget","metadata":{"seo":{"title":"Retrieve a card order","description":"Retrieves a card order based on the cardOrderId."}},"httpPath":"/v3/spend/profiles/{profileId}/card-orders/{cardOrderId}","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Retrieve available card programs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/card-order/cardorderprogramsget","routeSlug":"/api-reference/legacy/card-order/cardorderprogramsget","metadata":{"seo":{"title":"Retrieve available card programs","description":"Retrieves the list of available card programs for each profileId."}},"httpPath":"/v3/spend/profiles/{profileId}/card-orders/availability","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Retrieve card order requirements","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/card-order/cardorderrequirementsget","routeSlug":"/api-reference/legacy/card-order/cardorderrequirementsget","metadata":{"seo":{"title":"Retrieve card order requirements","description":"Retrieves all card requirements for a cardOrderId. A valid card order needs all its requirements status to be COMPLETED."}},"httpPath":"/v3/spend/profiles/{profileId}/card-orders/{cardOrderId}/requirements","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Update card order status","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/card-order/cardorderstatusupdate","routeSlug":"/api-reference/legacy/card-order/cardorderstatusupdate","metadata":{"seo":{"title":"Update card order status","description":"Updates the status of a card order based on its cardOrderId. The status can be updated to one of the following:"}},"httpPath":"/v3/spend/profiles/{profileId}/card-orders/{cardOrderId}/status","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Validate an address","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/card-order/cardordervalidateaddress","routeSlug":"/api-reference/legacy/card-order/cardordervalidateaddress","metadata":{"seo":{"title":"Validate an address","description":"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."}},"httpPath":"/v3/spend/address/validate","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"separator","label":"Webhooks","variant":"secondary","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Card order status change","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/legacy/card-order/eventcardscardorderstatuschange","routeSlug":"/api-reference/legacy/card-order/eventcardscardorderstatuschange","metadata":{"seo":{"title":"Card order status change","description":"This event is triggered every time a card order status is updated. Statuses depend on the type of card (virtual/physical). Additional statuses related to delivery exist for physical cards."}},"httpPath":"cards#card-order-status-change","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"}],"version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Card Transactions","link":"/api-reference/legacy/card-transaction","routeSlug":"/api-reference/legacy/card-transaction","items":[{"label":"Get card transaction","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/card-transaction/cardtransactionget","routeSlug":"/api-reference/legacy/card-transaction/cardtransactionget","metadata":{"seo":{"title":"Get card transaction","description":"Retrieve a card transaction by its ID."}},"httpPath":"/v4/spend/profiles/{profileId}/cards/transactions/{transactionId}","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"List card transactions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/card-transaction/cardtransactionlist","routeSlug":"/api-reference/legacy/card-transaction/cardtransactionlist","metadata":{"seo":{"title":"List card transactions","description":"Retrieve a list of card transactions for a specific card. Transactions are ordered by transaction ID in descending order."}},"httpPath":"/v4/spend/profiles/{profileId}/cards/{cardToken}/transactions","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Get card transaction (V3)","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/card-transaction/cardtransactiongetv3","routeSlug":"/api-reference/legacy/card-transaction/cardtransactiongetv3","metadata":{"seo":{"title":"Get card transaction (V3)","description":"This endpoint is deprecated. Use the V4 Get card transaction endpoint instead."}},"httpPath":"/v3/spend/profiles/{profileId}/cards/transactions/{transactionId}","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"separator","label":"Webhooks","variant":"secondary","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Card transaction state change","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/legacy/card-transaction/eventcardstransactionstatechange","routeSlug":"/api-reference/legacy/card-transaction/eventcardstransactionstatechange","metadata":{"seo":{"title":"Card transaction state change","description":"Triggered whenever a new card transaction occurs or is modified."}},"httpPath":"cards#transaction-state-change","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"}],"version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Spend Limits","link":"/api-reference/legacy/spend-limits","routeSlug":"/api-reference/legacy/spend-limits","items":[{"type":"link","label":"Profile Limits","link":"/api-reference/legacy/spend-limits/profile-limits","routeSlug":"/api-reference/legacy/spend-limits/profile-limits","httpVerb":"schema","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"link","label":"Card Limits","link":"/api-reference/legacy/spend-limits/card-limits","routeSlug":"/api-reference/legacy/spend-limits/card-limits","httpVerb":"schema","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Retrieve profile limits","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/spend-limits/spendlimitsprofileget","routeSlug":"/api-reference/legacy/spend-limits/spendlimitsprofileget","metadata":{"seo":{"title":"Retrieve profile limits","description":"Retrieves the spend limits that are configured for a profile."}},"httpPath":"/v4/spend/profiles/{profileId}/spend-limits","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Update profile limits","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/spend-limits/spendlimitsprofileupdate","routeSlug":"/api-reference/legacy/spend-limits/spendlimitsprofileupdate","metadata":{"seo":{"title":"Update profile limits","description":"Update profile daily and monthly spend limits for PURCHASE or ATM_WITHDRAWAL. Both daily and monthly must be set."}},"httpPath":"/v4/spend/profiles/{profileId}/spend-limits","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Retrieve card limits","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/spend-limits/spendlimitscardget","routeSlug":"/api-reference/legacy/spend-limits/spendlimitscardget","metadata":{"seo":{"title":"Retrieve card limits","description":"Retrieves the spend limits that are configured for a card."}},"httpPath":"/v4/spend/profiles/{profileId}/cards/{cardToken}/spend-limits","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Create or update card limits","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/spend-limits/spendlimitscardupdate","routeSlug":"/api-reference/legacy/spend-limits/spendlimitscardupdate","metadata":{"seo":{"title":"Create or update card limits","description":"Create or update card transaction, daily, monthly or lifetime spend limits."}},"httpPath":"/v4/spend/profiles/{profileId}/cards/{cardToken}/spend-limits","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Delete card limits","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/spend-limits/spendlimitscarddelete","routeSlug":"/api-reference/legacy/spend-limits/spendlimitscarddelete","metadata":{"seo":{"title":"Delete card limits","description":"Delete card spend limits for a specific granularity."}},"httpPath":"/v4/spend/profiles/{profileId}/cards/{cardToken}/spend-limits/{granularity}","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Retrieve profile spend limits","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/spend-limits/spendcontrolsprofilelimitsget","routeSlug":"/api-reference/legacy/spend-limits/spendcontrolsprofilelimitsget","metadata":{"seo":{"title":"Retrieve profile spend limits","description":"Retrieves the spending limits that are configured for a profile."}},"httpPath":"/v3/spend/profiles/{profileId}/spending-limits","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"}],"version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Spend Controls","link":"/api-reference/legacy/spend-controls","routeSlug":"/api-reference/legacy/spend-controls","items":[{"type":"link","label":"Authorisation Rule","link":"/api-reference/legacy/spend-controls/rule","routeSlug":"/api-reference/legacy/spend-controls/rule","httpVerb":"schema","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Add a new authorisation rule","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/spend-controls/spendcontrolsrulecreate","routeSlug":"/api-reference/legacy/spend-controls/spendcontrolsrulecreate","metadata":{"seo":{"title":"Add a new authorisation rule","description":"Creates an authorisation rule. It won't be enabled unless it is applied."}},"httpPath":"/v3/spend/applications/{clientId}/spend-controls/rules","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"List all authorisation rules","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/spend-controls/spendcontrolsruleslist","routeSlug":"/api-reference/legacy/spend-controls/spendcontrolsruleslist","metadata":{"seo":{"title":"List all authorisation rules","description":"Retrieves all the existing authorisation rules, regardless of whether or not they are applied."}},"httpPath":"/v3/spend/applications/{clientId}/spend-controls/rules","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Apply an authorisation rule","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/spend-controls/spendcontrolsruleapply","routeSlug":"/api-reference/legacy/spend-controls/spendcontrolsruleapply","metadata":{"seo":{"title":"Apply an authorisation rule","description":"Apply an authorisation rule. This will result in the rule being evaluated against every incoming card authorisation request."}},"httpPath":"/v3/spend/applications/{clientId}/spend-controls/rules/apply","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Unapply an authorisation rule","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/spend-controls/spendcontrolsruleunapply","routeSlug":"/api-reference/legacy/spend-controls/spendcontrolsruleunapply","metadata":{"seo":{"title":"Unapply an authorisation rule","description":"Deactivates an authorisation rule. This will result in all card transactions not being evaluated against this rule."}},"httpPath":"/v3/spend/applications/{clientId}/spend-controls/rules/unapply","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"List applied authorisation rules","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/spend-controls/spendcontrolsappliedruleslist","routeSlug":"/api-reference/legacy/spend-controls/spendcontrolsappliedruleslist","metadata":{"seo":{"title":"List applied authorisation rules","description":"Returns the list of all the active authorisation rules that have been applied."}},"httpPath":"/v3/spend/applications/{clientId}/spend-controls/rules/applied","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Delete an authorisation rule","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/spend-controls/spendcontrolsruledelete","routeSlug":"/api-reference/legacy/spend-controls/spendcontrolsruledelete","metadata":{"seo":{"title":"Delete an authorisation rule","description":"Deletes an authorisation rule that is currently not applied.If a rule is applied, you should unapply the rule before deleting it."}},"httpPath":"/v3/spend/applications/{clientId}/spend-controls/rules/{ruleId}","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"}],"version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Digital Wallet","link":"/api-reference/legacy/digital-wallet","routeSlug":"/api-reference/legacy/digital-wallet","items":[{"label":"List payment tokens for a card","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/digital-wallet/pushprovisioningpaymenttokenslist","routeSlug":"/api-reference/legacy/digital-wallet/pushprovisioningpaymenttokenslist","metadata":{"seo":{"title":"List payment tokens for a card","description":"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. Note that the payment token status associated with the card may not be accurate (for example, after a phone factory reset). Therefore, it's advisable to consistently check the wallet instance for the most up-to-date token status."}},"httpPath":"/v3/spend/profiles/{profileId}/cards/{cardToken}/payment-tokens","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Manual provisioning payment token activation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/digital-wallet/digitalwalletactivatepaymenttoken","routeSlug":"/api-reference/legacy/digital-wallet/digitalwalletactivatepaymenttoken","metadata":{"seo":{"title":"Manual provisioning payment token activation","description":"This endpoint activates the payment token for a card that has been manually added to a wallet provider. Please read this guide before implementing this API."}},"httpPath":"/v3/spend/profiles/{profileId}/cards/{cardToken}/payment-tokens/{paymentTokenUniqueReference}/activation","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Push provisioning for Google Pay","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/digital-wallet/pushprovisioninggooglepayget","routeSlug":"/api-reference/legacy/digital-wallet/pushprovisioninggooglepayget","metadata":{"seo":{"title":"Push provisioning for Google Pay","description":"Returns encrypted cardholder information and other metadata needed for Google Pay push provisioning."}},"httpPath":"/twcard-data/v1/push-provisioning/encrypted-payload/google-pay","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Push Provisioning for Apple Pay","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/digital-wallet/pushprovisioningapplepayget","routeSlug":"/api-reference/legacy/digital-wallet/pushprovisioningapplepayget","metadata":{"seo":{"title":"Push Provisioning for Apple Pay","description":"Returns encrypted cardholder information and other metadata needed for Apple Pay push provisioning."}},"httpPath":"/twcard-data/v1/push-provisioning/encrypted-payload/apple-pay","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"}],"version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Disputes","link":"/api-reference/legacy/disputes","routeSlug":"/api-reference/legacy/disputes","items":[{"label":"Dispute dynamic flow entry point","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/disputes/disputedynamicflowstep","routeSlug":"/api-reference/legacy/disputes/disputedynamicflowstep","metadata":{"seo":{"title":"Dispute dynamic flow entry point","description":"Retrieves the JSON for initiating the dispute flow. Use this endpoint with Wise'sDynamic Flow framework."}},"httpPath":"/v3/spend/profiles/{profileId}/dispute-form/flows/step/{scheme}/{reason}","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Retrieve dispute reasons","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/disputes/disputereasonsget","routeSlug":"/api-reference/legacy/disputes/disputereasonsget","metadata":{"seo":{"title":"Retrieve dispute reasons","description":"Retrieves the list of possible reasons for submitting a dispute."}},"httpPath":"/v3/spend/profiles/{profileId}/dispute-form/reasons","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Submit dispute","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/disputes/disputesubmit","routeSlug":"/api-reference/legacy/disputes/disputesubmit","metadata":{"seo":{"title":"Submit dispute","description":"Submit a dispute for a card transaction."}},"httpPath":"/v3/spend/profiles/{profileId}/dispute-form/flows/{scheme}/{reason}","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Upload dispute file","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/disputes/disputefileupload","routeSlug":"/api-reference/legacy/disputes/disputefileupload","metadata":{"seo":{"title":"Upload dispute file","description":"Upload a file for use in a dispute submission. Use the returned file ID in the files object when submitting a dispute."}},"httpPath":"/v4/spend/profiles/{profileId}/dispute-form/file","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"List disputes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/disputes/disputelist","routeSlug":"/api-reference/legacy/disputes/disputelist","metadata":{"seo":{"title":"List disputes","description":"List disputes for a profile with optional filters."}},"httpPath":"/v3/spend/profiles/{profileId}/disputes","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Get dispute","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/disputes/disputeget","routeSlug":"/api-reference/legacy/disputes/disputeget","metadata":{"seo":{"title":"Get dispute","description":"Retrieve a dispute by its ID."}},"httpPath":"/v3/spend/profiles/{profileId}/disputes/{disputeId}","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Withdraw dispute","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/disputes/disputewithdraw","routeSlug":"/api-reference/legacy/disputes/disputewithdraw","metadata":{"seo":{"title":"Withdraw dispute","description":"Withdraw a dispute by setting its status to CLOSED."}},"httpPath":"/v3/spend/profiles/{profileId}/disputes/{disputeId}/status","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Upload dispute file (v3)","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/disputes/disputefileuploadv3","routeSlug":"/api-reference/legacy/disputes/disputefileuploadv3","metadata":{"seo":{"title":"Upload dispute file (v3)","description":"This endpoint is deprecated. Use the v4 upload dispute file endpoint instead."}},"httpPath":"/v3/spend/profiles/{profileId}/dispute-form/file","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"separator","label":"Webhooks","variant":"secondary","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Transaction disputes update","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/legacy/disputes/eventtransactiondisputesupdate","routeSlug":"/api-reference/legacy/disputes/eventtransactiondisputesupdate","metadata":{"seo":{"title":"Transaction disputes update","description":"Triggered every time a transaction dispute is submitted or updated."}},"httpPath":"transaction-disputes#update","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"}],"version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"separator","label":"Quotes","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Quotes","link":"/api-reference/legacy/quote","routeSlug":"/api-reference/legacy/quote","items":[{"type":"link","label":"Quote","link":"/api-reference/legacy/quote/quote","routeSlug":"/api-reference/legacy/quote/quote","httpVerb":"schema","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Create a quote (unauthenticated)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/quote/quotecreateunauthenticated","routeSlug":"/api-reference/legacy/quote/quotecreateunauthenticated","metadata":{"seo":{"title":"Create a quote (unauthenticated)","description":"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.Note 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."}},"httpPath":"/v3/quotes","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Create a quote (authenticated)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/quote/quotecreate","routeSlug":"/api-reference/legacy/quote/quotecreate","metadata":{"seo":{"title":"Create a quote (authenticated)","description":"You 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."}},"httpPath":"/v3/profiles/{profileId}/quotes","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Retrieve a quote by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/quote/quoteget","routeSlug":"/api-reference/legacy/quote/quoteget","metadata":{"seo":{"title":"Retrieve a quote by ID","description":"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."}},"httpPath":"/v3/profiles/{profileId}/quotes/{quoteId}","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Update a quote","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/quote/quoteupdate","routeSlug":"/api-reference/legacy/quote/quoteupdate","metadata":{"seo":{"title":"Update a quote","description":"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."}},"httpPath":"/v3/profiles/{profileId}/quotes/{quoteId}","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"}],"version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Exchange Rates","link":"/api-reference/legacy/rate","routeSlug":"/api-reference/legacy/rate","items":[{"label":"Retrieve current rates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/rate/rateget","routeSlug":"/api-reference/legacy/rate/rateget","metadata":{"seo":{"title":"Retrieve current rates","description":"The from, to, and group parameters are not testable in our Sandbox environment at this time."}},"httpPath":"/v1/rates","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"}],"version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Comparison","link":"/api-reference/legacy/comparison","routeSlug":"/api-reference/legacy/comparison","items":[{"label":"Request a comparison quote","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/comparison/comparisonget","routeSlug":"/api-reference/legacy/comparison/comparisonget","metadata":{"seo":{"title":"Request a comparison quote","description":"Request price and speed comparison data for money transfer providers on a given currency route."}},"httpPath":"/v4/comparisons","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Request a comparison quote (V3)","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/comparison/comparisongetv3","routeSlug":"/api-reference/legacy/comparison/comparisongetv3","metadata":{"seo":{"title":"Request a comparison quote (V3)","description":"This endpoint is deprecated. Use the V4 comparison endpoint instead."}},"httpPath":"/v3/comparisons","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"}],"version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"separator","label":"Recipients","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Recipient Accounts","link":"/api-reference/legacy/recipient","routeSlug":"/api-reference/legacy/recipient","items":[{"type":"link","label":"Recipient Account","link":"/api-reference/legacy/recipient/recipient","routeSlug":"/api-reference/legacy/recipient/recipient","httpVerb":"schema","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Create a recipient account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/recipient/recipientcreate","routeSlug":"/api-reference/legacy/recipient/recipientcreate","metadata":{"seo":{"title":"Create a recipient account","description":"Creates a recipient account. A recipient is a person or institution who is the ultimate beneficiary of a transfer."}},"httpPath":"/v1/accounts","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"List recipient accounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/recipient/recipientlist","routeSlug":"/api-reference/legacy/recipient/recipientlist","metadata":{"seo":{"title":"List recipient accounts","description":"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."}},"httpPath":"/v2/accounts","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Get account by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/recipient/recipientget","routeSlug":"/api-reference/legacy/recipient/recipientget","metadata":{"seo":{"title":"Get account by ID","description":"Get recipient account info by ID."}},"httpPath":"/v2/accounts/{accountId}","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Deactivate a recipient account","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/recipient/recipientdeactivate","routeSlug":"/api-reference/legacy/recipient/recipientdeactivate","metadata":{"seo":{"title":"Deactivate a recipient account","description":"Deletes a recipient by changing its status to inactive (\"active\": false)."}},"httpPath":"/v2/accounts/{accountId}","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Retrieve recipient account requirements dynamically","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/recipient/recipientaccountrequirementsget","routeSlug":"/api-reference/legacy/recipient/recipientaccountrequirementsget","metadata":{"seo":{"title":"Retrieve recipient account requirements dynamically","description":"Please note that to use v1.1 Accept-Minor-Version: 1 request header must be set."}},"httpPath":"/v1/quotes/{quoteId}/account-requirements","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Retrieve recipient account requirements dynamically (step-by-step)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/recipient/recipientaccountrequirementspost","routeSlug":"/api-reference/legacy/recipient/recipientaccountrequirementspost","metadata":{"seo":{"title":"Retrieve recipient account requirements dynamically (step-by-step)","description":"POST the same recipient account payload that you will POST to /v1/accounts."}},"httpPath":"/v1/quotes/{quoteId}/account-requirements","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Check account and quote compatibility","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/recipient/recipientcompatibilitycheck","routeSlug":"/api-reference/legacy/recipient/recipientcompatibilitycheck","metadata":{"seo":{"title":"Check account and quote compatibility","description":"Use this endpoint to check the compatibility of a recipient account with a quote before creating a transfer. This validation includes:"}},"httpPath":"/v2/accounts/{accountId}/quotes/{quoteId}/compatibility","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Accept confirmation outcomes","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/recipient/recipientconfirmationsaccept","routeSlug":"/api-reference/legacy/recipient/recipientconfirmationsaccept","metadata":{"seo":{"title":"Accept confirmation outcomes","description":"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."}},"httpPath":"/v2/accounts/{accountId}/confirmations","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"List recipient accounts (v1)","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/recipient/recipientlistv1","routeSlug":"/api-reference/legacy/recipient/recipientlistv1","metadata":{"seo":{"title":"List recipient accounts (v1)","description":"This is a deprecated v1 endpoint. For new integrations please use the v2 list endpoint."}},"httpPath":"/v1/accounts","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Get account by ID (v1)","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/recipient/recipientgetv1","routeSlug":"/api-reference/legacy/recipient/recipientgetv1","metadata":{"seo":{"title":"Get account by ID (v1)","description":"This is a deprecated v1 endpoint. For new integrations please use the v2 get endpoint."}},"httpPath":"/v1/accounts/{accountId}","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Check account and quote compatibility (v1)","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/recipient/recipientcompatibilitycheckv1","routeSlug":"/api-reference/legacy/recipient/recipientcompatibilitycheckv1","metadata":{"seo":{"title":"Check account and quote compatibility (v1)","description":"This is a deprecated v1 endpoint. For new integrations please use the v2 compatibility endpoint."}},"httpPath":"/v1/accounts/{accountId}/quotes/{quoteId}/compatibility","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"separator","label":"Webhooks","variant":"secondary","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Recipient state change","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/legacy/recipient/eventrecipientsstatechange","routeSlug":"/api-reference/legacy/recipient/eventrecipientsstatechange","metadata":{"seo":{"title":"Recipient state change","description":"Triggered when a recipient account created or changed through hosted recipient creation changes state.See the Embedded Flows guide for an example recipient creation flow."}},"httpPath":"recipients#state-change","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"}],"version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Contacts","link":"/api-reference/legacy/contact","routeSlug":"/api-reference/legacy/contact","items":[{"label":"Create a contact from an identifier","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/contact/contactcreate","routeSlug":"/api-reference/legacy/contact/contactcreate","metadata":{"seo":{"title":"Create a contact from an identifier","description":"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."}},"httpPath":"/v2/profiles/{profileId}/contacts","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"}],"version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"separator","label":"Transfers","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Transfers","link":"/api-reference/legacy/transfer","routeSlug":"/api-reference/legacy/transfer","items":[{"type":"link","label":"Standard Transfer","link":"/api-reference/legacy/transfer/transfer","routeSlug":"/api-reference/legacy/transfer/transfer","httpVerb":"schema","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"link","label":"Originator Transfer","link":"/api-reference/legacy/transfer/originator-transfer","routeSlug":"/api-reference/legacy/transfer/originator-transfer","httpVerb":"schema","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Get a transfer by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/transfer/transferget","routeSlug":"/api-reference/legacy/transfer/transferget","metadata":{"seo":{"title":"Get a transfer by ID","description":"Get transfer info by ID. To receive dynamic updates as the state of the transfer changes, see the webhooks documentation."}},"httpPath":"/v1/transfers/{transferId}","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Cancel a transfer","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/transfer/transfercancel","routeSlug":"/api-reference/legacy/transfer/transfercancel","metadata":{"seo":{"title":"Cancel a transfer","description":"Transfers may be cancelled up until the transfer has been processed and funds converted. Cancellation is final — it cannot be undone."}},"httpPath":"/v1/transfers/{transferId}/cancel","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Validate transfer requirements","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/transfer/transferrequirementsvalidate","routeSlug":"/api-reference/legacy/transfer/transferrequirementsvalidate","metadata":{"seo":{"title":"Validate transfer requirements","description":"Exposes transfer-specific requirements based on the sender, quote, and target recipient account. Requirements vary by currency route, transfer amount, and regulatory region."}},"httpPath":"/v1/transfer-requirements","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Fund a Transfer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/transfer/transferfund","routeSlug":"/api-reference/legacy/transfer/transferfund","metadata":{"seo":{"title":"Fund a Transfer","description":"This endpoint is SCA protected when it applies. If your profile is registered within the UK and/or EEA, SCA most likely applies to you.Please read more about implementing SCA."}},"httpPath":"/v3/profiles/{profileId}/transfers/{transferId}/payments","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"List completed payments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/transfer/transferpaymentslist","routeSlug":"/api-reference/legacy/transfer/transferpaymentslist","metadata":{"seo":{"title":"List completed payments","description":"Fetch completed payments used to fund the transfer."}},"httpPath":"/v1/transfers/{transferId}/payments","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Get payout information","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/transfer/transferpayoutinfoget","routeSlug":"/api-reference/legacy/transfer/transferpayoutinfoget","metadata":{"seo":{"title":"Get payout information","description":"Fetch banking reference information for transfers that are in outgoing_payment_sent status, enabling you to track transfers with the transfer recipient's bank."}},"httpPath":"/v2/transfers/{transferId}/invoices/bankingpartner","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Get a transfer receipt","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/transfer/transferreceiptget","routeSlug":"/api-reference/legacy/transfer/transferreceiptget","metadata":{"seo":{"title":"Get a transfer receipt","description":"Download transfer confirmation receipt in PDF format for transfers that are in status outgoing_payment_sent.There's also the transfer state change webhook."}},"httpPath":"/v1/transfers/{transferId}/receipt.pdf","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Get a US combined disclosure receipt","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/transfer/transferuscombinedreceiptget","routeSlug":"/api-reference/legacy/transfer/transferuscombinedreceiptget","metadata":{"seo":{"title":"Get a US combined disclosure receipt","description":"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."}},"httpPath":"/v1/transfers/{transferId}/us-combined-receipt.pdf","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Get a non objection certificate (INR)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/transfer/transfernocget","routeSlug":"/api-reference/legacy/transfer/transfernocget","metadata":{"seo":{"title":"Get a non objection certificate (INR)","description":"Download transfer non objection certificate in PDF format for transfers that are in status outgoing_payment_sent."}},"httpPath":"/v1/transfers/{transferId}/documents/noc","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Create a partner licence transfer","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/transfer/transferpartnerlicencecreate","routeSlug":"/api-reference/legacy/transfer/transferpartnerlicencecreate","metadata":{"seo":{"title":"Create a partner licence transfer","description":"This endpoint is deprecated and only maintained for existing legacy integrations. Do not use it for new integrations. Use Create a transfer or Create a third party transfer instead."}},"httpPath":"/v1/profiles/{profileId}/partner-licence-transfers","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"separator","label":"Webhooks","variant":"secondary","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Transfer active cases","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/legacy/transfer/eventtransfersactivecases","routeSlug":"/api-reference/legacy/transfer/eventtransfersactivecases","metadata":{"seo":{"title":"Transfer active cases","description":"Triggered every time a transfer's list of active cases is updated.Active cases indicate potential problems with transfer processing."}},"httpPath":"transfers#active-cases","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Transfer refund","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/legacy/transfer/eventtransfersrefund","routeSlug":"/api-reference/legacy/transfer/eventtransfersrefund","metadata":{"seo":{"title":"Transfer refund","description":"This event provides information about refund amount and currency. Triggered every time a transfer's status becomes funds_refunded."}},"httpPath":"transfers#refund","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Transfer payout failure","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/legacy/transfer/eventtransferspayoutfailure","routeSlug":"/api-reference/legacy/transfer/eventtransferspayoutfailure","metadata":{"seo":{"title":"Transfer payout failure","description":"Triggered every time a payout fails. Use this event to get further information about a failed payment."}},"httpPath":"transfers#payout-failure","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Transfer state change","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/legacy/transfer/eventtransfersstatechange","routeSlug":"/api-reference/legacy/transfer/eventtransfersstatechange","metadata":{"seo":{"title":"Transfer state change","description":"Triggered every time a transfer's status is updated."}},"httpPath":"transfers#state-change","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"}],"version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Standard Transfers","link":"/api-reference/legacy/standard-transfer","routeSlug":"/api-reference/legacy/standard-transfer","items":[{"label":"Create a transfer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/standard-transfer/transfercreate","routeSlug":"/api-reference/legacy/standard-transfer/transfercreate","metadata":{"seo":{"title":"Create a transfer","description":"Create a transfer to a recipient account based on a quote."}},"httpPath":"/v1/transfers","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"List transfers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/standard-transfer/transferlist","routeSlug":"/api-reference/legacy/standard-transfer/transferlist","metadata":{"seo":{"title":"List transfers","description":"Get the list of transfers for a given user's profile (defaults to user's personal profile)."}},"httpPath":"/v1/transfers","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"}],"version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Third Party Transfers","link":"/api-reference/legacy/third-party-transfer","routeSlug":"/api-reference/legacy/third-party-transfer","items":[{"label":"Create a third party transfer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/third-party-transfer/createthirdpartytransfer","routeSlug":"/api-reference/legacy/third-party-transfer/createthirdpartytransfer","metadata":{"seo":{"title":"Create a third party transfer","description":"When creating a transfer on behalf of a third party, you must take note that:"}},"httpPath":"/v2/profiles/{profileId}/third-party-transfers","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Get a third party transfer by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/third-party-transfer/getthirdpartytransfer","routeSlug":"/api-reference/legacy/third-party-transfer/getthirdpartytransfer","metadata":{"seo":{"title":"Get a third party transfer by ID","description":"Get third party transfer info by ID. To receive dynamic updates as the state of the transfer changes, see the webhooks documentation."}},"httpPath":"/v2/profiles/{profileId}/third-party-transfers/{transferId}","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Get a third party transfer by ID (V1)","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/third-party-transfer/getthirdpartytransferv1","routeSlug":"/api-reference/legacy/third-party-transfer/getthirdpartytransferv1","metadata":{"seo":{"title":"Get a third party transfer by ID (V1)","description":"This endpoint is deprecated. Use Get a third party transfer by ID (V2) instead."}},"httpPath":"/v1/profiles/{profileId}/third-party-transfers/{transferId}","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"}],"version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Delivery Estimate","link":"/api-reference/legacy/delivery-estimate","routeSlug":"/api-reference/legacy/delivery-estimate","items":[{"label":"Get the delivery estimate for a transfer","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/delivery-estimate/deliveryestimateget","routeSlug":"/api-reference/legacy/delivery-estimate/deliveryestimateget","metadata":{"seo":{"title":"Get the delivery estimate for a transfer","description":"Get the live delivery estimate for a transfer by the transfer ID."}},"httpPath":"/v1/delivery-estimates/{transferId}","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"}],"version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Currencies","link":"/api-reference/legacy/currencies","routeSlug":"/api-reference/legacy/currencies","items":[{"label":"Get all currencies allowed for transfers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/currencies/currenciesget","routeSlug":"/api-reference/legacy/currencies/currenciesget","metadata":{"seo":{"title":"Get all currencies allowed for transfers","description":"Returns all currencies available for creating transfers. Currency names are returned in English by default — pass an Accept-Language header to receive localized names."}},"httpPath":"/v1/currencies","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"}],"version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Batch Payment Groups","link":"/api-reference/legacy/batch-group","routeSlug":"/api-reference/legacy/batch-group","items":[{"type":"link","label":"Batch Group","link":"/api-reference/legacy/batch-group/batchgroup","routeSlug":"/api-reference/legacy/batch-group/batchgroup","httpVerb":"schema","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Create a batch group","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/batch-group/batchgroupcreate","routeSlug":"/api-reference/legacy/batch-group/batchgroupcreate","metadata":{"seo":{"title":"Create a batch group","description":"Create a new batch group."}},"httpPath":"/v3/profiles/{profileId}/batch-groups","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Retrieve a batch group","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/batch-group/batchgroupget","routeSlug":"/api-reference/legacy/batch-group/batchgroupget","metadata":{"seo":{"title":"Retrieve a batch group","description":"Get an existing batch group by ID."}},"httpPath":"/v3/profiles/{profileId}/batch-groups/{batchGroupId}","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Update batch group status","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/batch-group/batchgroupupdate","routeSlug":"/api-reference/legacy/batch-group/batchgroupupdate","metadata":{"seo":{"title":"Update batch group status","description":"Update a batch group's status to complete or cancel it."}},"httpPath":"/v3/profiles/{profileId}/batch-groups/{batchGroupId}","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Create a batch group transfer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/batch-group/batchgrouptransfercreate","routeSlug":"/api-reference/legacy/batch-group/batchgrouptransfercreate","metadata":{"seo":{"title":"Create a batch group transfer","description":"Create a transfer in the batch group using a previously created recipient account and quote."}},"httpPath":"/v3/profiles/{profileId}/batch-groups/{batchGroupId}/transfers","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Fund a batch group","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/batch-group/batchgroupfund","routeSlug":"/api-reference/legacy/batch-group/batchgroupfund","metadata":{"seo":{"title":"Fund a batch group","description":"Funds all transfers in a batch group from a multi-currency account balance. Transfers are paid out immediately."}},"httpPath":"/v3/profiles/{profileId}/batch-payments/{batchGroupId}/payments","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Fund a batch group via direct debit","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/batch-group/batchgrouppaymentinitiationcreate","routeSlug":"/api-reference/legacy/batch-group/batchgrouppaymentinitiationcreate","metadata":{"seo":{"title":"Fund a batch group via direct debit","description":"Funds all transfers in a batch group via direct debit. The batch group must be in the COMPLETED state."}},"httpPath":"/v1/profiles/{profileId}/batch-groups/{batchGroupId}/payment-initiations","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Retrieve a payment initiation","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/batch-group/batchgrouppaymentinitiationget","routeSlug":"/api-reference/legacy/batch-group/batchgrouppaymentinitiationget","metadata":{"seo":{"title":"Retrieve a payment initiation","description":"Get payment initiation info by ID. In addition to webhooks, this endpoint can be used for polling the status of a payment initiation."}},"httpPath":"/v1/profiles/{profileId}/batch-groups/{batchGroupId}/payment-initiations/{paymentInitiationId}","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"separator","label":"Webhooks","variant":"secondary","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Batch payment initiations state change","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/legacy/batch-group/eventbatchpaymentinitiationsstatechange","routeSlug":"/api-reference/legacy/batch-group/eventbatchpaymentinitiationsstatechange","metadata":{"seo":{"title":"Batch payment initiations state change","description":"Triggered when the payment initiation state of a batch group payment changes."}},"httpPath":"batch-payment-initiations#state-change","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"}],"version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"separator","label":"Funding","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Payin Deposit Detail","link":"/api-reference/legacy/payin-deposit-detail","routeSlug":"/api-reference/legacy/payin-deposit-detail","items":[{"label":"Retrieve bank transfer deposit details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/payin-deposit-detail/payindepositdetailget","routeSlug":"/api-reference/legacy/payin-deposit-detail/payindepositdetailget","metadata":{"seo":{"title":"Retrieve bank transfer deposit details","description":"Retrieve the bank details for the account that the customer should send funds to when paying for a Wise transfer via a bank transfer."}},"httpPath":"/v1/profiles/{profileId}/transfers/{transferId}/deposit-details/bank-transfer","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"}],"version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Direct Debit Account","link":"/api-reference/legacy/direct-debit-account","routeSlug":"/api-reference/legacy/direct-debit-account","items":[{"label":"Create a direct debit account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/direct-debit-account/directdebitaccountcreate","routeSlug":"/api-reference/legacy/direct-debit-account/directdebitaccountcreate","metadata":{"seo":{"title":"Create a direct debit account","description":"Register a new external bank account for funding batch transfers via direct debit."}},"httpPath":"/v1/profiles/{profileId}/direct-debit-accounts","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Retrieve all direct debit accounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/direct-debit-account/directdebitaccountget","routeSlug":"/api-reference/legacy/direct-debit-account/directdebitaccountget","metadata":{"seo":{"title":"Retrieve all direct debit accounts","description":"Get a list of your direct debit accounts. Use the type and currency query parameters to filter accounts."}},"httpPath":"/v1/profiles/{profileId}/direct-debit-accounts","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"}],"version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Bulk Settlement","link":"/api-reference/legacy/bulk-settlement","routeSlug":"/api-reference/legacy/bulk-settlement","items":[{"label":"Send a settlement journal","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/bulk-settlement/bulksettlementjournalcreate","routeSlug":"/api-reference/legacy/bulk-settlement/bulksettlementjournalcreate","metadata":{"seo":{"title":"Send a settlement journal","description":"Sends the settlement journal to Wise. There are two types of settlement:"}},"httpPath":"/v1/settlements","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"separator","label":"Webhooks","variant":"secondary","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Bulk settlement payment received","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/legacy/bulk-settlement/eventbulksettlementpaymentreceived","routeSlug":"/api-reference/legacy/bulk-settlement/eventbulksettlementpaymentreceived","metadata":{"seo":{"title":"Bulk settlement payment received","description":"Triggered when a bulk settlement fund is received. Once there is a match, meaning the amount for this settlement journal is fully settled, the amount_matched is set to true. If it is not matched, check the difference between source_amount and target_amount to determine how much more needs to be paid."}},"httpPath":"bulk-settlement#payment-received","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"}],"version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Payins","link":"/api-reference/legacy/payins","routeSlug":"/api-reference/legacy/payins","items":[{"label":"Create PayNow payment details","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/payins/paynowcreate","routeSlug":"/api-reference/legacy/payins/paynowcreate","metadata":{"seo":{"title":"Create PayNow payment details","description":"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. This operation supports the SGD currency only."}},"httpPath":"/v1/profiles/{profileId}/payin-sessions/{payinSessionId}/paynow","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"}],"version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"separator","label":"Webhooks","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Subscriptions","link":"/api-reference/legacy/webhook","routeSlug":"/api-reference/legacy/webhook","items":[{"label":"Create Application Webhook Subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/webhook/webhookapplicationsubscriptioncreate","routeSlug":"/api-reference/legacy/webhook/webhookapplicationsubscriptioncreate","metadata":{"seo":{"title":"Create Application Webhook Subscription","description":"Create a webhook subscription at the application level."}},"httpPath":"/v3/applications/{clientKey}/subscriptions","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"List Application Webhook Subscriptions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/webhook/webhookapplicationsubscriptionlist","routeSlug":"/api-reference/legacy/webhook/webhookapplicationsubscriptionlist","metadata":{"seo":{"title":"List Application Webhook Subscriptions","description":"List all webhook subscriptions for your application."}},"httpPath":"/v3/applications/{clientKey}/subscriptions","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Get Application Webhook Subscription","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/webhook/webhookapplicationsubscriptionget","routeSlug":"/api-reference/legacy/webhook/webhookapplicationsubscriptionget","metadata":{"seo":{"title":"Get Application Webhook Subscription","description":"Retrieve an application webhook subscription by its identifier."}},"httpPath":"/v3/applications/{clientKey}/subscriptions/{subscriptionId}","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Delete Application Webhook Subscription","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/webhook/webhookapplicationsubscriptiondelete","routeSlug":"/api-reference/legacy/webhook/webhookapplicationsubscriptiondelete","metadata":{"seo":{"title":"Delete Application Webhook Subscription","description":"Delete an application webhook subscription by its identifier."}},"httpPath":"/v3/applications/{clientKey}/subscriptions/{subscriptionId}","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Test Application Webhook Subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/webhook/webhookapplicationsubscriptiontest","routeSlug":"/api-reference/legacy/webhook/webhookapplicationsubscriptiontest","metadata":{"seo":{"title":"Test Application Webhook Subscription","description":"Generate test notifications for an existing application subscription."}},"httpPath":"/v3/applications/{clientKey}/subscriptions/{subscriptionId}/test-notifications","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Create Profile Webhook Subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/webhook/webhookprofilesubscriptioncreate","routeSlug":"/api-reference/legacy/webhook/webhookprofilesubscriptioncreate","metadata":{"seo":{"title":"Create Profile Webhook Subscription","description":"Create a webhook subscription at the profile level."}},"httpPath":"/v3/profiles/{profileId}/subscriptions","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"List Profile Webhook Subscriptions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/webhook/webhookprofilesubscriptionlist","routeSlug":"/api-reference/legacy/webhook/webhookprofilesubscriptionlist","metadata":{"seo":{"title":"List Profile Webhook Subscriptions","description":"List all webhook subscriptions for a profile."}},"httpPath":"/v3/profiles/{profileId}/subscriptions","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Get Profile Webhook Subscription","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/webhook/webhookprofilesubscriptionget","routeSlug":"/api-reference/legacy/webhook/webhookprofilesubscriptionget","metadata":{"seo":{"title":"Get Profile Webhook Subscription","description":"Retrieve a profile webhook subscription by its identifier."}},"httpPath":"/v3/profiles/{profileId}/subscriptions/{subscriptionId}","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Delete Profile Webhook Subscription","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/webhook/webhookprofilesubscriptiondelete","routeSlug":"/api-reference/legacy/webhook/webhookprofilesubscriptiondelete","metadata":{"seo":{"title":"Delete Profile Webhook Subscription","description":"Delete a profile webhook subscription by its identifier."}},"httpPath":"/v3/profiles/{profileId}/subscriptions/{subscriptionId}","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"}],"version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Events","link":"/api-reference/legacy/webhook-event","routeSlug":"/api-reference/legacy/webhook-event","items":[{"label":"Transfer active cases","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/legacy/webhook-event/eventtransfersactivecases","routeSlug":"/api-reference/legacy/webhook-event/eventtransfersactivecases","metadata":{"seo":{"title":"Transfer active cases","description":"Triggered every time a transfer's list of active cases is updated.Active cases indicate potential problems with transfer processing."}},"httpPath":"transfers#active-cases","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Transfer refund","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/legacy/webhook-event/eventtransfersrefund","routeSlug":"/api-reference/legacy/webhook-event/eventtransfersrefund","metadata":{"seo":{"title":"Transfer refund","description":"This event provides information about refund amount and currency. Triggered every time a transfer's status becomes funds_refunded."}},"httpPath":"transfers#refund","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Transfer payout failure","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/legacy/webhook-event/eventtransferspayoutfailure","routeSlug":"/api-reference/legacy/webhook-event/eventtransferspayoutfailure","metadata":{"seo":{"title":"Transfer payout failure","description":"Triggered every time a payout fails. Use this event to get further information about a failed payment."}},"httpPath":"transfers#payout-failure","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Transfer state change","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/legacy/webhook-event/eventtransfersstatechange","routeSlug":"/api-reference/legacy/webhook-event/eventtransfersstatechange","metadata":{"seo":{"title":"Transfer state change","description":"Triggered every time a transfer's status is updated."}},"httpPath":"transfers#state-change","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Account details order state change","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/legacy/webhook-event/eventaccountdetailsorderstatechange","routeSlug":"/api-reference/legacy/webhook-event/eventaccountdetailsorderstatechange","metadata":{"seo":{"title":"Account details order state change","description":"The event contains information about the order state and requirement state. Triggered when there is a change in the state of an account details order."}},"httpPath":"account-details-order#order-state-change","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Account details payment state change","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/legacy/webhook-event/eventaccountdetailspaymentstatechange","routeSlug":"/api-reference/legacy/webhook-event/eventaccountdetailspaymentstatechange","metadata":{"seo":{"title":"Account details payment state change","description":"Triggered every time a pay-in is made into the specified account details."}},"httpPath":"account-details-payment#state-change","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Card status change","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/legacy/webhook-event/eventcardscardstatuschange","routeSlug":"/api-reference/legacy/webhook-event/eventcardscardstatuschange","metadata":{"seo":{"title":"Card status change","description":"This event is triggered for the initial card status as well as any subsequent updates."}},"httpPath":"cards#card-status-change","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Card production status change","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/legacy/webhook-event/eventcardscardproductionstatuschange","routeSlug":"/api-reference/legacy/webhook-event/eventcardscardproductionstatuschange","metadata":{"seo":{"title":"Card production status change","description":"Triggered every time a card production status is updated. This webhook is solely used for physical cards with KIOSK_COLLECTION delivery method."}},"httpPath":"cards#card-production-status-change","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"3DS challenge","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/legacy/webhook-event/eventcards3dschallenge","routeSlug":"/api-reference/legacy/webhook-event/eventcards3dschallenge","metadata":{"seo":{"title":"3DS challenge","description":"Triggered when a customer initiates a push notification for 3DS. The provided information can be used to send a push notification to the customer's mobile app."}},"httpPath":"cards#3ds-challenge","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Card order status change","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/legacy/webhook-event/eventcardscardorderstatuschange","routeSlug":"/api-reference/legacy/webhook-event/eventcardscardorderstatuschange","metadata":{"seo":{"title":"Card order status change","description":"This event is triggered every time a card order status is updated. Statuses depend on the type of card (virtual/physical). Additional statuses related to delivery exist for physical cards."}},"httpPath":"cards#card-order-status-change","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Card transaction state change","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/legacy/webhook-event/eventcardstransactionstatechange","routeSlug":"/api-reference/legacy/webhook-event/eventcardstransactionstatechange","metadata":{"seo":{"title":"Card transaction state change","description":"Triggered whenever a new card transaction occurs or is modified."}},"httpPath":"cards#transaction-state-change","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Cards manual provisioning verification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/legacy/webhook-event/eventcardsmanualprovisioningverification","routeSlug":"/api-reference/legacy/webhook-event/eventcardsmanualprovisioningverification","metadata":{"seo":{"title":"Cards manual provisioning verification","description":"Triggered when a card is manually added to a wallet provider, and the verification methods required to complete the wallet provisioning are returned."}},"httpPath":"cards#manual-provisioning-verification","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Hold limit breach update","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/legacy/webhook-event/eventholdlimitbreachupdate","routeSlug":"/api-reference/legacy/webhook-event/eventholdlimitbreachupdate","metadata":{"seo":{"title":"Hold limit breach update","description":"Triggered whenever a hold limit breach is opened or closed for a profile. A hold limit breach occurs when a balance exceeds the regulatory hold limit (applicable in countries such as Singapore and Malaysia)."}},"httpPath":"hold-limit-breach#update","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Additional verification state change","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/legacy/webhook-event/eventprofilescddcheckstatechange","routeSlug":"/api-reference/legacy/webhook-event/eventprofilescddcheckstatechange","metadata":{"seo":{"title":"Additional verification state change","description":"This event pushes updates for the Additional Customer Verification process."}},"httpPath":"profiles#cdd-check-state-change","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Overdraft limit threshold","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/legacy/webhook-event/eventprofilesoverdraftlimitthreshold","routeSlug":"/api-reference/legacy/webhook-event/eventprofilesoverdraftlimitthreshold","metadata":{"seo":{"title":"Overdraft limit threshold","description":"Triggered when the overdraft limit usage has reached 70% threshold. The event at each threshold is triggered maximum once per hour."}},"httpPath":"profiles#overdraft-limit-threshold","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Profile state change","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/legacy/webhook-event/eventprofilesstatechange","routeSlug":"/api-reference/legacy/webhook-event/eventprofilesstatechange","metadata":{"seo":{"title":"Profile state change","description":"Triggered every time a profile's state is updated."}},"httpPath":"profiles#state-change","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Verification state change","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/legacy/webhook-event/eventprofilesverificationstatechange","routeSlug":"/api-reference/legacy/webhook-event/eventprofilesverificationstatechange","metadata":{"seo":{"title":"Verification state change","description":"Triggered when the verification state of a connected profile changes."}},"httpPath":"profiles#verification-state-change","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"KYC review state change","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/legacy/webhook-event/eventkycreviewsstatechange","routeSlug":"/api-reference/legacy/webhook-event/eventkycreviewsstatechange","metadata":{"seo":{"title":"KYC review state change","description":"Triggered when a KYC review state has changed."}},"httpPath":"kyc-reviews#state-change","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"User state change","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/legacy/webhook-event/eventusersstatechange","routeSlug":"/api-reference/legacy/webhook-event/eventusersstatechange","metadata":{"seo":{"title":"User state change","description":"Triggered every time a user's state is updated."}},"httpPath":"users#state-change","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Balance update","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/legacy/webhook-event/eventbalancesupdate","routeSlug":"/api-reference/legacy/webhook-event/eventbalancesupdate","metadata":{"seo":{"title":"Balance update","description":"Triggered every time a multi-currency account is credited or debited."}},"httpPath":"balances#update","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Balance account state change","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/legacy/webhook-event/eventbalancesaccountstatechange","routeSlug":"/api-reference/legacy/webhook-event/eventbalancesaccountstatechange","metadata":{"seo":{"title":"Balance account state change","description":"Triggered every time a balance account is activated or deactivated."}},"httpPath":"balances#account-state-change","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Batch payment initiations state change","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/legacy/webhook-event/eventbatchpaymentinitiationsstatechange","routeSlug":"/api-reference/legacy/webhook-event/eventbatchpaymentinitiationsstatechange","metadata":{"seo":{"title":"Batch payment initiations state change","description":"Triggered when the payment initiation state of a batch group payment changes."}},"httpPath":"batch-payment-initiations#state-change","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Partner support case changed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/legacy/webhook-event/eventpartnersupportcasechanged","routeSlug":"/api-reference/legacy/webhook-event/eventpartnersupportcasechanged","metadata":{"seo":{"title":"Partner support case changed","description":"Triggered every time a case is updated, including if commented on or if the status is changed. Note that you will also receive a webhook response when you have created a new case or updated a case."}},"httpPath":"partner-support#case-changed","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Swift receive credit","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/legacy/webhook-event/eventswiftincredit","routeSlug":"/api-reference/legacy/webhook-event/eventswiftincredit","metadata":{"seo":{"title":"Swift receive credit","description":"Triggered every time a SWIFT message is received and a credit is deposited into a balance account."}},"httpPath":"swift-in#credit","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Swift message received","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/legacy/webhook-event/eventswiftmessagereceived","routeSlug":"/api-reference/legacy/webhook-event/eventswiftmessagereceived","metadata":{"seo":{"title":"Swift message received","description":"Triggered when a SWIFT message (e.g., pacs.008) is received and processed by Wise on behalf of a partner."}},"httpPath":"swift#message-received","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Transaction disputes update","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/legacy/webhook-event/eventtransactiondisputesupdate","routeSlug":"/api-reference/legacy/webhook-event/eventtransactiondisputesupdate","metadata":{"seo":{"title":"Transaction disputes update","description":"Triggered every time a transaction dispute is submitted or updated."}},"httpPath":"transaction-disputes#update","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Bulk settlement payment received","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/legacy/webhook-event/eventbulksettlementpaymentreceived","routeSlug":"/api-reference/legacy/webhook-event/eventbulksettlementpaymentreceived","metadata":{"seo":{"title":"Bulk settlement payment received","description":"Triggered when a bulk settlement fund is received. Once there is a match, meaning the amount for this settlement journal is fully settled, the amount_matched is set to true. If it is not matched, check the difference between source_amount and target_amount to determine how much more needs to be paid."}},"httpPath":"bulk-settlement#payment-received","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Recipient state change","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/legacy/webhook-event/eventrecipientsstatechange","routeSlug":"/api-reference/legacy/webhook-event/eventrecipientsstatechange","metadata":{"seo":{"title":"Recipient state change","description":"Triggered when a recipient account created or changed through hosted recipient creation changes state.See the Embedded Flows guide for an example recipient creation flow."}},"httpPath":"recipients#state-change","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Balance credit","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/legacy/webhook-event/eventbalancescredit","routeSlug":"/api-reference/legacy/webhook-event/eventbalancescredit","metadata":{"seo":{"title":"Balance credit","description":"Triggered every time a multi-currency account is credited."}},"httpPath":"balances#credit","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"}],"version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"separator","label":"Simulations","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Simulations","link":"/api-reference/legacy/simulation","routeSlug":"/api-reference/legacy/simulation","items":[{"label":"Simulate transfer state change","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/simulation/simulationtransferstatechange","routeSlug":"/api-reference/legacy/simulation/simulationtransferstatechange","metadata":{"seo":{"title":"Simulate transfer state change","description":"Changes the transfer status to the specified state. The available state transitions are:"}},"httpPath":"/v1/simulation/transfers/{transferId}/{status}","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Simulate transfer payout failure","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/simulation/simulationtransferpayoutfailure","routeSlug":"/api-reference/legacy/simulation/simulationtransferpayoutfailure","metadata":{"seo":{"title":"Simulate transfer payout failure","description":"Triggers transfers#payout-failure webhook for the transfer."}},"httpPath":"/v1/simulation/transfers/{transferId}/payout-failure","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Simulate verification for a profile","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/simulation/simulationverification","routeSlug":"/api-reference/legacy/simulation/simulationverification","metadata":{"seo":{"title":"Simulate verification for a profile","description":"Changes a specific profile's verification state to PASSED."}},"httpPath":"/v1/simulation/profiles/{profileId}/verifications","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Simulate verification for all profiles","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/simulation/simulationverifyprofile","routeSlug":"/api-reference/legacy/simulation/simulationverifyprofile","metadata":{"seo":{"title":"Simulate verification for all profiles","description":"Verifies all profiles associated with the authenticated user, changing their verification state to PASSED."}},"httpPath":"/v1/simulation/verify-profile","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Simulate a balance top-up","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/simulation/simulationbalancetopup","routeSlug":"/api-reference/legacy/simulation/simulationbalancetopup","metadata":{"seo":{"title":"Simulate a balance top-up","description":"Simulates a top-up so that a balance can be used to fund transfers and/or card spend."}},"httpPath":"/v1/simulation/balance/topup","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Simulate a card transaction authorisation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/simulation/simulationcardtransactionauthorisation","routeSlug":"/api-reference/legacy/simulation/simulationcardtransactionauthorisation","metadata":{"seo":{"title":"Simulate a card transaction authorisation","description":"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."}},"httpPath":"/v2/simulation/spend/profiles/{profileId}/cards/{cardToken}/transactions/authorisation","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Simulate a card transaction clearing","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/simulation/simulationcardtransactionclearing","routeSlug":"/api-reference/legacy/simulation/simulationcardtransactionclearing","metadata":{"seo":{"title":"Simulate a card transaction clearing","description":"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."}},"httpPath":"/v1/simulation/spend/profiles/{profileId}/cards/{cardToken}/transactions/clearing","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Simulate a card transaction reversal","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/simulation/simulationcardtransactionreversal","routeSlug":"/api-reference/legacy/simulation/simulationcardtransactionreversal","metadata":{"seo":{"title":"Simulate a card transaction reversal","description":"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."}},"httpPath":"/v1/simulation/spend/profiles/{profileId}/cards/{cardToken}/transactions/reversal","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"List simulated card transactions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/simulation/simulationcardtransactions","routeSlug":"/api-reference/legacy/simulation/simulationcardtransactions","metadata":{"seo":{"title":"List simulated card transactions","description":"Returns a list of simulated card transactions, in descending order of creation time."}},"httpPath":"/v2/simulation/spend/profiles/{profileId}/cards/{cardToken}/transactions","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Simulate card production state change","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/simulation/simulationcardproduction","routeSlug":"/api-reference/legacy/simulation/simulationcardproduction","metadata":{"seo":{"title":"Simulate card production state change","description":"Simulates a card production status change in the sandbox environment."}},"httpPath":"/v1/simulation/spend/profiles/{profileId}/cards/{cardToken}/production","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"List KYC review requirements","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/simulation/simulationkycreviewrequirementslist","routeSlug":"/api-reference/legacy/simulation/simulationkycreviewrequirementslist","metadata":{"seo":{"title":"List KYC review requirements","description":"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."}},"httpPath":"/v2/simulation/profiles/{profileId}/kyc-reviews/{kycReviewId}/requirements","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Simulate adding new requirement","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/simulation/simulationkycreviewrequirementsadd","routeSlug":"/api-reference/legacy/simulation/simulationkycreviewrequirementsadd","metadata":{"seo":{"title":"Simulate adding new requirement","description":"Creates a new requirement for a KYC (Know Your Customer) review for a business profile."}},"httpPath":"/v2/simulation/profiles/{profileId}/kyc-reviews/{kycReviewId}/requirements/add","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Simulate requirement submission","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/simulation/simulationkycreviewrequirementssubmit","routeSlug":"/api-reference/legacy/simulation/simulationkycreviewrequirementssubmit","metadata":{"seo":{"title":"Simulate requirement submission","description":"Simulates providing everything needed for a particular KYC requirement. This can be used in place of going through a hosted journey on the browser."}},"httpPath":"/v2/simulation/profiles/{profileId}/kyc-reviews/{kycReviewId}/requirements/submit","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Simulate verifying a KYC review","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/simulation/simulationkycreviewverify","routeSlug":"/api-reference/legacy/simulation/simulationkycreviewverify","metadata":{"seo":{"title":"Simulate verifying a KYC review","description":"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."}},"httpPath":"/v2/simulation/profiles/{profileId}/kyc-reviews/{kycReviewId}/verify","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Simulate incoming bank transfer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/simulation/simulationbanktransactionimport","routeSlug":"/api-reference/legacy/simulation/simulationbanktransactionimport","metadata":{"seo":{"title":"Simulate incoming bank transfer","description":"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."}},"httpPath":"/v1/simulation/profiles/{profileId}/bank-transactions/import","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Simulate incoming Swift payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/simulation/simulationswiftin","routeSlug":"/api-reference/legacy/simulation/simulationswiftin","metadata":{"seo":{"title":"Simulate incoming Swift payment","description":"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."}},"httpPath":"/v1/simulation/profiles/{profileId}/swift-in","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"}],"version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"separator","label":"Partner Support","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"group","label":"Cases","link":"/api-reference/legacy/case","routeSlug":"/api-reference/legacy/case","items":[{"label":"Create a case","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/case/casecreate","routeSlug":"/api-reference/legacy/case/casecreate","metadata":{"seo":{"title":"Create a case","description":"Cases are used to collect or transmit additional information between Partners and Wise. Use this endpoint to create a new case."}},"httpPath":"/v1/cases","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Retrieve a case by ID","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/case/caseget","routeSlug":"/api-reference/legacy/case/caseget","metadata":{"seo":{"title":"Retrieve a case by ID","description":"This endpoint returns a case based on the specified case ID."}},"httpPath":"/v1/cases/{caseId}","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Retrieve case comments","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/case/casecommentsget","routeSlug":"/api-reference/legacy/case/casecommentsget","metadata":{"seo":{"title":"Retrieve case comments","description":"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)."}},"httpPath":"/v1/cases/{caseId}/comments","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Add a case comment","deprecated":true,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/case/casecommentcreate","routeSlug":"/api-reference/legacy/case/casecommentcreate","metadata":{"seo":{"title":"Add a case comment","description":"This endpoint allows for a comment to be placed on a case."}},"httpPath":"/v1/cases/{caseId}/comments","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"type":"separator","label":"Webhooks","variant":"secondary","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"},{"label":"Partner support case changed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/legacy/case/eventpartnersupportcasechanged","routeSlug":"/api-reference/legacy/case/eventpartnersupportcasechanged","metadata":{"seo":{"title":"Partner support case changed","description":"Triggered every time a case is updated, including if commented on or if the status is changed. Note that you will also receive a webhook response when you have created a new case or updated a case."}},"httpPath":"partner-support#case-changed","version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"}],"version":"legacy","isDefault":false,"versionFolderId":"1b9c9f54"}]}